Skip to main content
GET
/
v1
/
integration
/
projects
List projects
curl --request GET \
  --url https://api.aivra.cloud/v1/integration/projects \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "is_private": true,
    "slug": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

​
Propósito

Retorna os projetos disponíveis no workspace associado à sua chave de API. Útil para obter o project_id antes de listar ou criar prompts.

​
Parâmetros

Sem parâmetros. A seleção de workspace é feita pela chave vinculada.

​
Dados retornados

Array de objetos com id, name, slug, description, is_private, created_at.

​
Exemplo de requisição

curl -H "X-API-Key: ak_xxxxxxxxx" "${BASE_URL}/v1/integration/projects"

​
Exemplo de resposta

[
  {
    "id": "proj_abc",
    "name": "Projeto A",
    "slug": "projeto-a",
    "description": "",
    "is_private": true,
    "created_at": "2025-11-27T12:00:00Z"
  }
]

​
Códigos de status

  • 200 Sucesso
  • 401/403 problemas de autenticação ou escopo

​
Casos de uso

  • Popular dropdown de seleção de projeto em um painel de integração

Authorizations

​
X-API-Key
string
header
required

Response

200 - application/json

OK

​
id
string
required
​
name
string
required
​
is_private
boolean
required
​
slug
string | null
​
description
string | null
​
created_at
string<date-time> | null