Dokploy
Generated

Ai

GET
/ai.one

Ai one

/ai.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

aiId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/ai.one?aiId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/ai.getModels

Ai get Models

/ai.getModels

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

apiUrl
Required
string

Minimum length: 1

apiKey
Required
string

curl -X GET "https://your-dokploy-instance.com/api/ai.getModels?apiUrl=string&apiKey=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/ai.create

Ai create

/ai.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

apiUrl
Required
string

Format: "uri"

apiKey
Required
string

model
Required
string

Minimum length: 1

isEnabled
Required
boolean

curl -X POST "https://your-dokploy-instance.com/api/ai.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "apiUrl": "http://example.com",
    "apiKey": "string",
    "model": "string",
    "isEnabled": true
  }'

Successful response

{}

POST
/ai.update

Ai update

/ai.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

aiId
Required
string

Minimum length: 1

namestring

Minimum length: 1

apiUrlstring

Format: "uri"

apiKeystring

modelstring

Minimum length: 1

isEnabledboolean

createdAtstring

curl -X POST "https://your-dokploy-instance.com/api/ai.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string",
    "name": "string",
    "apiUrl": "http://example.com",
    "apiKey": "string",
    "model": "string",
    "isEnabled": true,
    "createdAt": "string"
  }'

Successful response

{}

GET
/ai.getAll

Ai get All

/ai.getAll

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/ai.getAll" \
  -H "Authorization: <token>"

Successful response

{}

GET
/ai.get

Ai get

/ai.get

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

aiId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/ai.get?aiId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/ai.delete

Ai delete

/ai.delete

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

aiId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/ai.delete" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string"
  }'

Successful response

{}

POST
/ai.suggest

Ai suggest

/ai.suggest

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

aiId
Required
string

input
Required
string

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/ai.suggest" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "aiId": "string",
    "input": "string",
    "serverId": "string"
  }'

Successful response

{}

POST
/ai.deploy

Ai deploy

/ai.deploy

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

environmentId
Required
string

Minimum length: 1

id
Required
string

Minimum length: 1

dockerCompose
Required
string

Minimum length: 1

envVariables
Required
string

serverIdstring

name
Required
string

Minimum length: 1

description
Required
string

domainsarray<object>

configFilesarray<object>

curl -X POST "https://your-dokploy-instance.com/api/ai.deploy" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "environmentId": "string",
    "id": "string",
    "dockerCompose": "string",
    "envVariables": "string",
    "serverId": "string",
    "name": "string",
    "description": "string",
    "domains": [
      {
        "host": "string",
        "port": 1,
        "serviceName": "string"
      }
    ],
    "configFiles": [
      {
        "filePath": "string",
        "content": "string"
      }
    ]
  }'

Successful response

{}

Previous

Admin

Next

Application