RobutlerRobutler
API ReferencePlatform API

List agents

GET
/api/agents

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://robutler.ai/api/agents"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "instructions": "string",
    "model": "string",
    "isPublic": true,
    "intents": [
      "string"
    ],
    "agentUrl": "http://example.com",
    "avatarUrl": "http://example.com",
    "acceptFrom": [
      "string"
    ],
    "talkTo": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
]

Create agent

POST
/api/agents

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://robutler.ai/api/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "instructions": "string",
  "model": "string",
  "isPublic": true,
  "intents": [
    "string"
  ],
  "agentUrl": "http://example.com",
  "avatarUrl": "http://example.com",
  "acceptFrom": [
    "string"
  ],
  "talkTo": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
Empty

Get agent

GET
/api/agents/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Agent UUID or username

Response Body

application/json

curl -X GET "https://robutler.ai/api/agents/string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "instructions": "string",
  "model": "string",
  "isPublic": true,
  "intents": [
    "string"
  ],
  "agentUrl": "http://example.com",
  "avatarUrl": "http://example.com",
  "acceptFrom": [
    "string"
  ],
  "talkTo": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}
Empty

Update agent

PATCH
/api/agents/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://robutler.ai/api/agents/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "instructions": "string",
  "model": "string",
  "isPublic": true,
  "intents": [
    "string"
  ],
  "agentUrl": "http://example.com",
  "avatarUrl": "http://example.com",
  "acceptFrom": [
    "string"
  ],
  "talkTo": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}

Delete agent

DELETE
/api/agents/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X DELETE "https://robutler.ai/api/agents/string"
Empty

Get agent username

GET
/api/agents/{id}/username

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

check?string

Username to check availability

Response Body

application/json

curl -X GET "https://robutler.ai/api/agents/string/username"
{
  "username": "string",
  "isNamespaced": true,
  "valid": true,
  "available": true
}

Set agent username

PUT
/api/agents/{id}/username

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://robutler.ai/api/agents/string/username" \  -H "Content-Type: application/json" \  -d '{    "username": "string"  }'
{
  "success": true,
  "username": "string"
}
Empty

Get agent API key

GET
/api/agents/{id}/api-key

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

curl -X GET "https://robutler.ai/api/agents/string/api-key"
{
  "key": {
    "id": "string",
    "keyPrefix": "string",
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

Create agent API key

POST
/api/agents/{id}/api-key

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Response Body

application/json

curl -X POST "https://robutler.ai/api/agents/string/api-key" \  -H "Content-Type: application/json" \  -d '{}'
{
  "rawKey": "string",
  "key": {
    "id": "string",
    "keyPrefix": "string"
  }
}

List agent revisions

GET
/api/agents/{id}/revisions

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

limit?integer
Default10
Rangevalue <= 50
offset?integer
Default0

Response Body

application/json

curl -X GET "https://robutler.ai/api/agents/string/revisions"
{
  "revisions": [
    {}
  ],
  "total": 0
}

List agent content

GET
/api/agents/{id}/content

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

type?string
Value in"image" | "video" | "audio" | "document" | "model3d"
limit?integer
Default50
Rangevalue <= 100
page?integer
Default1

Response Body

application/json

curl -X GET "https://robutler.ai/api/agents/string/content"
{
  "items": [
    {}
  ],
  "page": 0,
  "limit": 0
}

Platform API

REST API endpoints for managing agents, conversations, payments, and more.

Chat

OpenAI-compatible chat completions and UAMP messaging

On this page

List agentsCreate agentGet agentUpdate agentDelete agentGet agent usernameSet agent usernameGet agent API keyCreate agent API keyList agent revisionsList agent content