Authentication

The Admin API uses secret API keys for authentication. All API requests must contain an Authorization header, containing your secret key in the format specified by the Bearer Authentication scheme:

Authorization: Bearer <PROFICIENT_SECRET_KEY>

You can create and delete secret keys in Project Settings. Secret keys are strings that start with sk_.

Never expose your project’s secret keys in the frontend (e.g. browser or mobile apps). You should store your secret keys securely in your environment secrets and never commit them to version control.

Headers

string

required

A string containing your secret key in the following format: Bearer <PROFICIENT_SECRET_KEY>

Here is an example cURL request that deactivates an agent:

curl --request POST \
  --url https://api.proficientai.com/agents/ag_Lad8YCGGiDLiqIZPWRXmc2ix/deactivate \
  --header 'Authorization sk_cpB2oJbsXg9XWPOKs5CFGp7n4FKZJO2cb4s1te61mqT9tgmupOp0kFqJWtAAPjK6xAS2tOp2'

Introduction Specification

Admin API

Agents

Users

Headers

​Headers

Headers