Loading ...

REST API: Axero Copilot Create Conversation | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Axero Copilot » REST API: Axero Copilot Create Conversation
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Axero Copilot Create Conversation

0 
 /5
0 (0votes)
Open API Guide
POST/api/chatbot/chat

Start a new Axero Copilot conversation or continue an existing one. The Copilot processes your input and responds using information available to the authenticated user. You can optionally specify a profile to customize the Copilot's behavior.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
Bearer TokenStringYESHeaderAuthorization Header: Authorization: Bearer YOUR_JWT_TOKEN Most secure method. Include your Bearer token in the Authorization header of every request.
messageStringYESBodyRequest Body Parameter: The input or query sent to the chatbot for a response. This is a required field in the JSON request body. { "message": "What's the company's policy on remote work?" }

Optional Parameters

ParameterTypeRequiredLocationDescription
conversation_idIntegerNOBodyRequest Body Parameter: The ID of an existing conversation. If not provided, a new conversation will be initiated. Use this to continue an existing conversation thread. { "conversation_id": "50b828ea-d84e-446f-b05e-1b2e8b12208b" }
bot_profileStringNOBodyRequest Body Parameter: The ProfileId of a specific bot profile to use for this conversation (passed as a string). When specified and valid, the chatbot loads that profile and overrides all Copilot settings with the profile's configuration, system prompt, and scope settings. When missing or invalid, the system falls back to the default profile. This parameter enables profile-based customization of chatbot behavior without changing global settings. Use the GET /api/chatbot/profile endpoint to retrieve available ProfileId values. { "bot_profile": "2" }

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/chatbot/chat

Request Body

{
  "message": "What’s the company’s policy on remote work?"
}

Success Response

{
  "IsError": false,
  "ResponseData": {
    "Conversation_id": "50b828ea-d84e-446f-b05e-1b2e8b12208b",
    "Footer": "\n- [Work From Home Policy](https://your-site.com/spaces/252/human-resources/wiki/view/8497/work-from-home-policy?language=en-US) _(r:100)_",
    "Logs": [
      "Searching at Axero...\n   Keywords: remote work policy\n  Question: What’s the company’s policy on remote work?"
    ],
    "Message": {
      "Key": "Value"
    },
    "Response_id": "7f244ce0-e8df-4514-91dc-953095b8fec9"
  },
  "ResponseMessage": "Success message."
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid.Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages