Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.actionx.top/llms.txt

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

The Backend API is best when you want to centralize ActionX requests on your server and then pass results to your frontend or other systems.

​
Unified endpoint

POST /api/v1/ads/request

​
What this endpoint does

  • Accepts query, response, user context, and slots
  • Enters the unified ActionX decisioning flow
  • Returns a result structure that fits the requested slot format

​
Authentication

Authorization: Bearer ak_your_api_key
You can also use X-API-Key.

​
Minimal request structure

{
  "conversationContext": {
    "query": "Recommend a lightweight office laptop",
    "response": "Here are a few options for work and travel."
  },
  "userContext": {
    "sessionId": "session-001",
    "userId": "user-001"
  },
  "slots": [
    {
      "slotId": "main-slot",
      "format": "action_card",
      "count": 3
    }
  ]
}

​
Continue reading

Request parameters

Continue into userContext, slots, and the most common fields.

Response format

Continue into slots, ads, and the common output structures.