Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.agentfirst.dev/llms.txt

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

See also the API reference for more detail.

​
Usage

‘s administration service lets you support your whitelabel customers. The service has a RESTful interface that accepts GET, POST, and PATCH requests at https://‍/users.
This endpoint is rate limited; if you receive a 429 response, pause for the backoff time required by the Retry-After header before making another request.

​
New customers

You can provision a user by specifying their email address and the API services to assign them access permission: 
curl -X POST 'https://api.agentfirst.dev/users' \
-H "Authorization: Bearer $AGENT_FIRST_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
  "email": "user@example.com",
  "services": ["search", "browser"]
}'
The user’s secret API token will be returned, along with their normalized email address and service permissions: 
{
  "email": "user@example.com",
  "token": "a1-0dF6qKHYD7SNU5kAtjOmwHpH3iFgpylA",
  "services": ["search", "browser"]
}
Here are the provisioning request keys and values:
KeyRequiredValue
email✅The email address of the user to create an account for; the address is case insensitive and can be up to 255 characters, regardless of character encoding
services✅An array of at least one of the API services to grant the account access to; the possible service values are search and browser
Here are the response keys and values:
KeyValue
emailThe email address of the new user account as recorded by the API
tokenThe bearer token issued by the API for authentication
servicesAn array of the API services that the account has been granted access to, search and browser being the possible values