Skip to main content
GET
/
v1
/
integration
/
prompts
/
{prompt_id}
Get prompt detail
curl --request GET \
  --url https://api.aivra.cloud/v1/integration/prompts/{prompt_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "project_id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "description": "<string>",
  "latest_version_id": "<string>",
  "active_version": {
    "id": "<string>",
    "prompt_id": "<string>",
    "version_number": 123,
    "content": "<string>",
    "metadata_": {},
    "created_at": "2023-11-07T05:31:56Z"
  }
}

​
Propósito

Obtém detalhes de um prompt específico. Opcionalmente retorna a versão ativa de um ambiente.

​
Parâmetros

  • prompt_id (path, string) obrigatório
  • environment (query, string) opcional. Ex.: production, staging

​
Dados retornados

id, project_id, key, name, description, latest_version_id, active_version.

​
Exemplo

curl -H "X-API-Key: ak_xxxxxxxxx" \
  "${BASE_URL}/v1/integration/prompts/pr_1?environment=production"
Resposta: 
{
  "id": "pr_1",
  "project_id": "proj_abc",
  "key": "welcome",
  "name": "Boas-vindas",
  "latest_version_id": "ver_12",
  "active_version": {
    "id": "ver_12",
    "prompt_id": "pr_1",
    "version_number": 12,
    "content": "...",
    "metadata_": null,
    "created_at": "2025-11-27T12:00:00Z"
  }
}

​
Códigos de status

  • 200 Sucesso
  • 404 Prompt não encontrado
  • 403 Workspace inválido ou projeto não autorizado

​
Casos de uso

  • Verificar conteúdo e versão ativa usada em produção

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
prompt_id
string
required

Query Parameters

​
environment
string

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
​
active_version
object