Agents

Get agent by API key

get

Fetches an agent by API key. The response includes the agent details.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Responses

200

Successfully retrieved the agent.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

get

/external/agents/by-api-key

HTTPcURLJavaScriptPython

GET /external/agents/by-api-key HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationName": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "publicName": "text",
  "role": "text",
  "description": "text",
  "vectorStoreId": "vs_1234567890",
  "aiConfig": {
    "id": "asst_1234567890",
    "model": "gpt-3.5-turbo",
    "temperature": 1,
    "topP": 1,
    "instructions": "text",
    "isCodeInterpreterEnabled": true,
    "isFileSearchEnabled": true,
    "fileSearchMaxNumResults": 10,
    "reasoningEffort": "medium",
    "isOutputJsonSchemaEnabled": true,
    "outputJsonSchema": "{\"type\": \"object\", \"properties\": {\"name\": {\"type\": \"string\"}}}"
  },
  "avatarUrl": "https://example.com/avatar.jpg",
  "status": "active",
  "tags": [
    "text"
  ],
  "skills": [
    {
      "systemName": "AGENT_SKILL_SYSTEM_NAME",
      "status": "active"
    }
  ]
}

Get agent statistic by API key

get

Fetches an agent statistic by API key. The response includes the agent statistic.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Query parameters

startDatestring · date-timeOptional

Start date of statistics calculation.

Example: 2024-03-20T12:00:00Z

endDatestring · date-timeOptional

End date of statistics calculation.

Example: 2024-03-20T12:00:00Z

Responses

200

Successfully retrieved the agent statistic.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

get

/external/agents/statistic

HTTPcURLJavaScriptPython

GET /external/agents/statistic HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "tokensUsed": 1,
  "tokensPerConversation": 1,
  "vapiSecondsUsed": 1,
  "averageCallDuration": 1,
  "smsUsed": 1,
  "smsPerConversation": 1,
  "emailsUsed": 1,
  "emailsPerConversation": 1
}

Create agent webhook

post

Creates a new webhook for the agent identified by the API key.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Body

application/json

titlestringRequired

Title of the webhook

Example: My Webhook

descriptionstringRequired

Description of the webhook

Example: This webhook is triggered when a message is received

urlstringRequired

URL where the webhook will be sent

Example: https://api.example.com/webhook

triggerConditionstring · enumRequired

Condition that triggers the webhook

Example: each_messagePossible values:

headersobjectOptional

Optional headers to be sent with the webhook

Example: {"Authorization":"Bearer token"}

Responses

201

Successfully created the webhook.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Agent not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

post

/external/agents/webhooks

HTTPcURLJavaScriptPython

POST /external/agents/webhooks HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "title": "My Webhook",
  "description": "This webhook is triggered when a message is received",
  "url": "https://api.example.com/webhook",
  "triggerCondition": "each_message",
  "headers": {
    "Authorization": "Bearer token"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "agentId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "My Webhook",
  "description": "This webhook is triggered when a message is received",
  "url": "https://api.example.com/webhook",
  "triggerCondition": "each_message",
  "headers": {
    "Authorization": "Bearer token"
  },
  "status": "active",
  "createdAt": "2024-03-20T12:00:00Z",
  "updatedAt": "2024-03-20T12:00:00Z"
}