Skip to main content
POST
/
v1
/
integration
/
prompts
Create prompt
curl --request POST \
  --url https://api.aivra.cloud/v1/integration/prompts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "project_id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "project_id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "description": "<string>",
  "latest_version_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

​
Propósito

Cria um novo prompt dentro de um projeto.

​
Parâmetros

Corpo JSON:
  • project_id (string) obrigatório
  • key (string) obrigatório
  • name (string) obrigatório
  • description (string) opcional

​
Dados retornados

Objeto do prompt recém-criado com id, project_id, key, name, description, latest_version_id, created_at.

​
Exemplo

curl -X POST "${BASE_URL}/v1/integration/prompts" \
  -H "X-API-Key: ak_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "proj_abc",
    "key": "onboarding",
    "name": "Onboarding",
    "description": "Fluxo inicial"
  }'

​
Códigos de status

  • 200 Sucesso
  • 404 Projeto não encontrado ou não pertence ao workspace
  • 403 Projeto não autorizado pela API Key

​
Casos de uso

  • Provisionar prompts a partir de pipelines de integração

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
project_id
string
required
​
key
string
required
​
name
string
required
​
description
string | null

Response

200 - application/json

OK

​
id
string
required
​
project_id
string
required
​
key
string
required
​
name
string
required
​
description
string | null
​
latest_version_id
string | null
​
created_at
string<date-time> | null