Create a secret

POST 
/ai/secrets

Create a new secret with a name associated to it which can be used as a reference to the secret in other API calls.

application/json

Body

required

name Name (string)required

The name of the secret.

value Value (string)required

The value of the secret.

201: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

id Id (string)required

name Name (string)required

value Value (string)required

Possible values: [*****]

created_at date-timerequired

{
  "data": {
    "id": "string",
    "name": "string",
    "value": "*****",
    "created_at": "2024-07-29T15:51:28.071Z"
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/secrets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "my_secret",
  "value": "my_secret_value"
}'

Response samples

• 201
• 422

---

{
  "data": {
    "id": "string",
    "name": "string",
    "value": "*****",
    "created_at": "2024-07-29T15:51:28.071Z"
  }
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}