Autenticação do agente: request

Visão geral

Inicie o login do agente para o usuário abrir o navegador e escolher o que autorizar. Este endpoint está fora da lista de permissões de api post. Mantenha privados os detalhes da sessão de login.

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

Este endpoint pertence ao protocolo de login e não está disponível por api post. Use o fluxo de login no navegador compatível e mantenha credenciais de sessão fora da saída e dos logs.

Autenticação e permissões

Classes de credenciais aceitas

delegated_oauth

Capacidade delegada

oauth-bootstrap

Função mínima no workspace

Não há função mínima de workspace neste contrato; as verificações de propriedade e permissão continuam valendo.

Escopo de acesso

Recursos que este usuário tem autorização para acessar

Consentimento para todos os workspaces obrigatório

Não

Altera o estado

Não

Quando a operação estiver concluída

not_agent_callable

Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso.

Campos da requisição

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "client_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "device_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "callback_uri": {
      "anyOf": [
        {
          "type": "string",
          "const": "http://127.0.0.1:8789/grant/callback"
        },
        {
          "type": "string",
          "maxLength": 2048,
          "format": "uri",
          "pattern": "^https:\\/\\/.*"
        }
      ]
    },
    "callback_state": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256
    }
  },
  "required": [
    "client_name",
    "device_name",
    "callback_uri",
    "callback_state"
  ],
  "additionalProperties": false
}

Resposta e conclusão

Códigos HTTP de sucesso: 200. Quando a operação estiver concluída: not_agent_callable.

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "approval_url": {
      "type": "string",
      "format": "uri"
    },
    "expires_in": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "request_id",
    "approval_url",
    "expires_in"
  ]
}

Erros e repetições seguras

Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez.

Exemplos

Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.

Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais.

request.json

{
  "client_name": "example",
  "device_name": "example",
  "callback_uri": "http://127.0.0.1:8789/grant/callback",
  "callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/request" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/request", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "client_name": "example",
  "device_name": "example",
  "callback_uri": "http://127.0.0.1:8789/grant/callback",
  "callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

Exemplo de resposta sintética

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "approval_url": "https://example.com/media.png",
  "expires_in": 1
}

Ferramentas e guias relacionados