Prompts

Process a prompt request

post

Processes a user prompt and returns an AI-generated response. The request must contain a valid API key.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Body

application/json

promptstringRequired

The question that the user sends to the AI agent

Example: How does quantum entanglement work?

tokenTrackingIdstringOptional

The ID of the token tracking

Example: any-token-id-323jbb3242dwfwefew34234

Responses

200

Successfully processed the prompt and returned a response.

application/json

statusstring · enumRequired

Response status

Example: completedPossible values:

totalTokensnumber · nullableRequired

Total number of tokens used for the request

Example: 12345

responsestring · nullableRequired

The AI-generated response to the user prompt

Example: The theory of relativity explains how time and space are linked

errorstring · nullableRequired

Response error

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/prompts

HTTPcURLJavaScriptPython

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

{
  "prompt": "How does quantum entanglement work?",
  "tokenTrackingId": "any-token-id-323jbb3242dwfwefew34234"
}

{
  "status": "completed",
  "totalTokens": 12345,
  "response": "The theory of relativity explains how time and space are linked",
  "error": "text"
}

Create a prompt request

post

Creates a user prompt and returns an ID. The request must contain a valid API key.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Body

application/json

promptstringRequired

The question that the user sends to the AI agent

Example: How does quantum entanglement work?

tokenTrackingIdstringOptional

The ID of the token tracking

Example: any-token-id-323jbb3242dwfwefew34234

Responses

200

Successfully created the prompt and returned an ID.

application/json

promptIdstringRequired

The ID of the prompt

Example: 1234567890

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/prompts/async

HTTPcURLJavaScriptPython

POST /external/prompts/async HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "prompt": "How does quantum entanglement work?",
  "tokenTrackingId": "any-token-id-323jbb3242dwfwefew34234"
}

{
  "promptId": "1234567890"
}

Get a response on prompt request

get

Returns a response on a user prompt by ID. The request must contain a valid API key.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Path parameters

idstringRequired

Provide the prompt ID to process.

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

Responses

200

Successfully returned a response on the prompt. Returns null if the prompt is not ready.

application/json

statusstring · enumRequired

Response status

Example: completedPossible values:

totalTokensnumber · nullableRequired

Total number of tokens used for the request

Example: 12345

responsestring · nullableRequired

The AI-generated response to the user prompt

Example: The theory of relativity explains how time and space are linked

errorstring · nullableRequired

Response error

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/prompts/{id}/response-on

HTTPcURLJavaScriptPython

GET /external/prompts/{id}/response-on HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "status": "completed",
  "totalTokens": 12345,
  "response": "The theory of relativity explains how time and space are linked",
  "error": "text"
}