Organization API Key

Create agent via organization API key

post

Creates an agent by organization API key. The response includes the agent details.

Authorizations

Organization-Secret-Key

Organization-Secret-KeystringRequired

Custom authentication header

Body

application/json

roleIdstring · uuidRequired

Agent role ID.

Example: 123e4567-e89b-12d3-a456-426614174000

namestringRequired

Name of the agent.

Example: My agent

publicNamestringRequired

Public name of the agent.

Example: My agent

descriptionstringOptional

Description of the agent.

Example: My agent description

disclaimerstringOptional

Disclaimer of the agent.

Example: My agent disclaimer

instructionsstringOptional

Instructions of the agent.

Example: My agent instructions

modelstring · enumOptional

Model of the agent.

Example: gpt-4oPossible values:

topPnumberOptional

TopP of the agent.

Example: 1

temperaturenumberOptional

Temperature of the agent.

Example: 1

isFileSearchEnabledbooleanOptional

Is file search enabled by default.

Example: false

isCodeInterpreterEnabledbooleanOptional

Is code interpreter enabled by default.

Example: false

fileSearchMaxNumResultsnumberOptional

File search max number of results. Required when isFileSearchEnabled is true.

Default: 10Example: 10

reasoningEffortstring · enumOptional

Reasoning effort of the agent. Required only when mode is reasoning.

Example: mediumPossible values:

isApiSkillEnabledbooleanOptional

Is agent API skill enabled by default.

Example: true

isOutputJsonSchemaEnabledbooleanOptional

Is output JSON schema enabled by default.

Example: false

outputJsonSchemastringRequired

Output JSON schema of the agent.

Example: {"type": "object", "properties": {"name": {"type": "string"}}}

tagsstring[]Required

Tags of the agent.

Example: ["Sales", "Support"]

Responses

201

Successfully created the agent.

application/json

403

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

application/json

500

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

application/json

post

/external/agents

HTTPcURLJavaScriptPython

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

{
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My agent",
  "publicName": "My agent",
  "description": "My agent description",
  "disclaimer": "My agent disclaimer",
  "instructions": "My agent instructions",
  "model": "gpt-4o",
  "topP": 1,
  "temperature": 1,
  "isFileSearchEnabled": false,
  "isCodeInterpreterEnabled": false,
  "fileSearchMaxNumResults": 10,
  "reasoningEffort": "medium",
  "isApiSkillEnabled": true,
  "isOutputJsonSchemaEnabled": false,
  "outputJsonSchema": "{\"type\": \"object\", \"properties\": {\"name\": {\"type\": \"string\"}}}",
  "tags": "[\"Sales\", \"Support\"]"
}

{
  "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"
    }
  ],
  "agentApiKey": "123e4567-e89b-12d3-a456-426614174000"
}

Get agent roles by organization API key

get

Fetches agent roles by organization API key. The response includes agent roles details.

Authorizations

Organization-Secret-Key

Organization-Secret-KeystringRequired

Custom authentication header

Responses

200

Successfully retrieved agent roles.

application/json

403

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

application/json

500

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

application/json

get

/external/agent-roles/by-api-key

HTTPcURLJavaScriptPython

GET /external/agent-roles/by-api-key HTTP/1.1
Host: api.raia2.com
Organization-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text"
}