Skip to main content
POST
/
api
/
agents
curl --request POST \
  --url https://app.outlit.ai/api/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "template",
  "templateKey": "churn",
  "mode": "draft"
}
'
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "agent": {
        "id": "<string>",
        "agentKey": "<string>",
        "displayName": "<string>",
        "templateVersion": "<string>",
        "actionKeys": [
          "<string>"
        ],
        "schedule": {
          "enabled": true,
          "nextRunAt": "2023-11-07T05:31:56Z",
          "lastRunAt": "2023-11-07T05:31:56Z",
          "lastSuccessfulRunAt": "2023-11-07T05:31:56Z"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}
{
  "error": "Invalid credentials"
}
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}
{
  "error": "Internal server error"
}
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

Authorizations

​
Authorization
string
header
required

Outlit API key using the Bearer ok_... format.

Body

application/json
​
type
string
required
Allowed value: "template"
​
templateKey
enum<string>
required
Available options:
churn
​
mode
enum<string>
Available options:
draft

Response

Agent was created.

​
ok
boolean
required
​
commandId
string
required
Allowed value: "agent.create"
​
commandVersion
integer
required
​
correlationId
string
required
​
result
object
required