Skip to main content
POST
/
v0
/
applications
/
{id}
/
api-keys
Create an API key for an application
curl --request POST \
  --url https://api.avidoai.com/v0/applications/{id}/api-keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "name": "Production API Key"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "key": "avido_prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Production API Key"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the application

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for creating a new API key

​
name
string
required

Human-friendly name for the API key

Required string length: 1 - 256
Example:

"Production API Key"

Response

Successfully created API key

Successful response for creating an API key

​
data
CreatedApiKey · object
required

Newly created API key including the plaintext key (returned once)