Skip to main content
POST
/
api
/
ai_agents
POST /api/ai_agents
curl --request POST \
  --url https://api.sippet.ai/api/ai_agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "relationships": {},
    "type": "AiAgent"
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "languages": [
        "<string>"
      ],
      "name": "<string>",
      "published": true,
      "workflow": {},
      "safety_guardrails": "<string>",
      "system_prompt": "<string>",
      "tone": "<string>",
      "voice": "<string>"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "meta": {}
        }
      }
    }
  },
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://sippet.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT for bearer authentication

Query Parameters

​
include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
​
fields
object

Limits the response fields to only those listed for each type

Example:
{
  "AiAgent": "id,name,voice,tone,languages,workflow,system_prompt,safety_guardrails,published"
}

Body

application/vnd.api+json

Request body for the /ai_agents operation on AiAgent resource

​
data
object
required

Response

Success

​
data
object

A "Resource object" representing a AiAgent

​
included
any[]
​
meta
object