Referência da API

Devolve o perfil do utilizador autenticado.

Atualiza campos do perfil, como o nome de exibição e as preferências de notificação.

Sincroniza o utilizador de autenticação Supabase com o registo de utilizador da plataforma.

Indica se o utilizador autenticado concluiu o onboarding.

Carrega uma nova imagem de avatar para o utilizador autenticado.

Lista os robôs registados pelo cliente autenticado, mais recentes primeiro, até 50 entradas. Os timestamps são ISO 8601; last_online e last_heartbeat são null até o robô se ter ligado pela primeira vez.

curl https://www.ay-robots.com/api/client/robots \
  -H 'Authorization: Bearer ayr_live_your_key_here'

[
  {
    "id": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11",
    "name": "Lab SO-100",
    "robot_type": "SO-100",
    "status": "AVAILABLE",
    "control_url": "wss://robots.example.com/so100/control",
    "stream_url": "https://robots.example.com/so100/stream",
    "hardware_id": "board:local:usb-1",
    "last_online": "2026-08-09T10:12:00.000Z",
    "last_heartbeat": "2026-08-09T10:12:00.000Z",
    "total_hours": 12.5,
    "tags": ["lab"],
    "notes": null,
    "created_at": "2026-07-01T09:00:00.000Z"
  }
]

Regista um novo robô e devolve o seu id. Um id de hardware de placa de motor só pode pertencer a um robô; uma colisão é rejeitada com o estado 409.

Devolve o perfil de cliente do utilizador autenticado.

Atualiza campos do perfil de cliente.

Lista os datasets na cloud do cliente com contagens de episódios e tamanhos.

Lista as faturas mensais do cliente.

Devolve estatísticas de utilização para o painel do cliente.

Devolve o perfil de operador do utilizador autenticado.

Cria ou atualiza o perfil de operador.

Lista robôs que estão atualmente disponíveis e correspondem às certificações do operador.

Lista os pedidos de certificação do operador e o seu estado.

Solicita certificação para um tipo de robô.

Devolve o calendário semanal de disponibilidade do operador.

Atualiza o calendário semanal de disponibilidade.

Devolve a disponibilidade atual do operador.

Devolve estatísticas de ganhos e sessões para o painel do operador.

Lista sessões para o utilizador autenticado. Os operadores veem as sessões que operaram; os clientes veem as sessões nos seus robôs. O conjunto de campos difere ligeiramente entre as duas vistas: a vista de cliente inclui episodes_collected e data_collected_mb, a vista de operador inclui operator_earnings_cents.

curl 'https://www.ay-robots.com/api/sessions?status=COMPLETED&limit=10' \
  -H 'Authorization: Bearer ayr_live_your_key_here'

{
  "sessions": [
    {
      "id": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
      "status": "COMPLETED",
      "started_at": "2026-08-08T14:00:12.000Z",
      "ended_at": "2026-08-08T14:47:31.000Z",
      "duration_minutes": 47,
      "client_charge_cents": 1175,
      "episodes_collected": 23,
      "data_collected_mb": 210.4,
      "rating": 5,
      "created_at": "2026-08-08T13:59:58.000Z",
      "robot_id": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11",
      "robot_name": "Lab SO-100",
      "robot_type": "SO-100",
      "operator_name": "Jane D."
    }
  ]
}

Inicia uma sessão de teleoperação num robô disponível. Exige a função de operador: os clientes não podem iniciar sessões. Um operador pode deter, no máximo, uma sessão ACTIVE ou PAUSED de cada vez, e o robô tem de ter atualmente o estado AVAILABLE. Num início imediato, o robô muda para IN_SESSION e o cliente é notificado.

curl -X POST https://www.ay-robots.com/api/sessions \
  -H 'Authorization: Bearer ayr_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"robotId": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11"}'

{
  "sessionId": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
  "status": "ACTIVE"
}

Devolve uma única sessão com os seus detalhes.

Atualiza o ciclo de vida da sessão: pausar, retomar, terminar e ações relacionadas.

Solicita uma extensão de sessão. Só o cliente dono da sessão pode chamar este endpoint, e a sessão tem de estar ACTIVE. O pedido é registado como um evento de sessão e o operador recebe uma notificação; a extensão em si acontece quando o operador reage a ela.

curl -X POST https://www.ay-robots.com/api/sessions/6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30/extend \
  -H 'Authorization: Bearer ayr_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"additionalMinutes": 30}'

{
  "message": "Extension request sent to operator"
}

Lista as mensagens de chat de uma sessão.

Envia uma mensagem de chat numa sessão.

Avalia uma sessão concluída numa escala de 1 a 5 estrelas, com um comentário opcional.

Exporta dados de sessão.

Cria ou devolve o cliente Stripe usado para a faturação do cliente.

Devolve o estado da conta Stripe Connect do operador.

Inicia o onboarding do Stripe Connect para pagamentos a operadores.

Cria um SetupIntent do Stripe para guardar um método de pagamento.

Cria uma sessão do portal de faturação do Stripe para gerir métodos de pagamento e faturas.

Devolve informação de pagamento para o operador autenticado.

Solicita um pagamento dos ganhos acumulados. O pagamento mínimo é de 10,00 EUR.

Recebe eventos de webhook do Stripe. Chamado pelo Stripe, não por clientes da API.

Verificação de saúde da API e da sua ligação à base de dados. Devolve 200 quando ambas estão bem; se a verificação da base de dados falhar, é devolvida a mesma estrutura com status e db definidos como error e o estado HTTP 503.

curl https://www.ay-robots.com/api/health

{
  "status": "ok",
  "db": "ok",
  "timestamp": "2026-08-09T10:12:00.000Z"
}

Devolve informação pública sobre um modelo de robô suportado.

Devolve os planos de preços públicos atuais.

Submete uma mensagem do formulário de contacto. A mensagem é primeiro guardada e depois entregue por email, para que uma falha temporária de correio não a perca: nesse caso a resposta reporta stored true e delivered false, e a entrega é repetida operacionalmente.

curl -X POST https://www.ay-robots.com/api/contact \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com",
    "category": "Technical Support",
    "subject": "SO-100 pairing question",
    "message": "My arm shows as offline after pairing."
  }'

{
  "success": true,
  "message": "Message sent successfully",
  "id": "b1f2c3d4-0000-0000-0000-000000000000",
  "stored": true,
  "delivered": true
}

Solicita suporte para um tipo de robô que ainda não está na plataforma.

Devolve estatísticas públicas da plataforma.