Skip to main content
This endpoint accepts a backend SDK key via the X-OTAS-SDK-KEY header and, if valid, returns the associated project details. It is called by the Brain service to authorize incoming agent event requests, but you can also use it directly to confirm that a key is active, unexpired, and correctly formed before deploying it to a production environment.
This endpoint does not require a user JWT. It authenticates solely via the X-OTAS-SDK-KEY header. No request body is needed.

​
Request

Method: POST
URL: http://localhost:8000/api/project/v1/sdk/backend/key/authenticate/
Authentication: X-OTAS-SDK-KEY header

​
Headers

​
X-OTAS-SDK-KEY
string
required
Full backend SDK key in the format otas_<prefix>_<secret>, as returned by the key-creation endpoint.

​
Response

​
status
integer
required
1 on success, 0 on failure.
​
status_description
string
required
authenticated on success.
​
response
object

​
Example

curl --request POST \
  --url http://localhost:8000/api/project/v1/sdk/backend/key/authenticate/ \
  --header 'X-OTAS-SDK-KEY: otas_aBcDeFgH_vErYlOnGsEcReTvAlUeHeRe'

{
  "status": 1,
  "status_description": "authenticated",
  "response": {
    "project": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "My Agent App",
      "description": "Production project for the recommendation agent"
    }
  }
}

​
Error responses

status_descriptionHTTP statusCause
missing_sdk_key401The X-OTAS-SDK-KEY header was absent from the request.
invalid_sdk_key401The key does not match any active, unexpired key in the database, or has been revoked.

Build docs developers (and LLMs) love

Get started for freeTalk to us