FRELY / Perguntas Frequentes

Utilizar modelos e API keys

API keys, definições do cliente, utilização e o que fazer quando um pedido falha.

As ferramentas de conta estão acessíveis a partir de uma aplicação de IA ligada ao FrelyMCP (https://mcp.frely.cloud/mcp, através de frely_list e frely_call) ou a partir de um terminal com a Frely CLI: frely api describe <tool>, seguido de frely api call <tool>. As ferramentas que alteram algo necessitam da sua aprovação no site da Frely.

01

Como criar uma API key?

Abra a página da API key na sua consola e crie uma. Uma API key autoriza chamadas a modelos, não ações de gestão. Guarde-a na configuração protegida do seu cliente. Nunca a coloque no Git, em capturas de ecrã nem em conversas. Revogar uma API key impede utilizações posteriores.

Ferramentas de API: keys.listkeys.createkeys.set_limits

02

Qual é o URL base da API da Frely?

https://api.frely.cloud. Utilize sempre https: os pedidos por http simples são recusados, pelo que um cliente configurado com http://api.frely.cloud falhará. O mesmo endereço serve todos os protocolos, por exemplo https://api.frely.cloud/v1/chat/completions, /v1/responses, /v1/messages, /v1/embeddings e a lista de modelos em /v1/models. Alguns clientes querem o URL base com /v1 no fim (https://api.frely.cloud/v1) e acrescentam eles próprios o caminho do endpoint.

Ferramentas de API: models.available

03

Como autenticar pedidos de API?

Envie a sua API key como bearer token: Authorization: Bearer <a sua API key>. Adicione Content-Type: application/json aos pedidos com corpo. Um pedido sem uma API key válida recebe um 401. Uma API key autoriza apenas chamadas a modelos, não a gestão da conta.

Ferramentas de API: keys.listkeys.create

04

Qual é o aspeto de uma resposta de erro?

Um corpo JSON com o formato {"error":{"message","type","param","code"}}. O tipo segue o estado HTTP: 401 authentication_error, 402 insufficient_quota, 403 permission_error, 404 not_found_error, 408 ou 504 timeout_error, 429 rate_limit_error, outros 4xx invalid_request_error, 503 service_unavailable_error, outros 5xx server_error. Cada resposta traz um cabeçalho x-request-id; guarde-o quando contactar o suporte. Uma falha recuperável pode incluir um cabeçalho Retry-After em segundos.

Ferramentas de API: request_history.list

05

O que introduzir na minha app de IA ou no cliente?

Três valores: o endereço público do serviço para o protocolo que escolheu (não um endereço interno), a sua própria API key e um nome de modelo público visível para a sua conta. As instruções da sua conta mostram os valores exatos.

Ferramentas de API: models.availablekeys.list

06

Como adicionar o Frely ao Claude ou ao ChatGPT?

Adicione o Frely como conector, utilize o endereço do FrelyMCP como URL do servidor MCP, escolha OAuth, inicie sessão no Frely e aprove o acesso. Os guias passo a passo mostram cada ecrã.

07

Um modelo aparece na lista, mas não consigo chamá-lo.

Estar listado não é autorização para chamar. Verifique o seu plano, o saldo, o limite e os termos do serviço, e pergunte a um administrador autorizado se estiver num Team. Rodar as API keys não contorna uma restrição.

Ferramentas de API: models.availablebudget.getcredits.account

08

O meu pedido falhou ou expirou.

Mantenha uma nota da hora, do protocolo, do nome do modelo e do ID do pedido, com os dados sensíveis removidos, e consulte o seu histórico de pedidos. Um timeout ou uma ligação interrompida não prova que nada foi utilizado, por isso verifique a utilização antes de repetir o pedido. Não envie credenciais, corpos de pedidos nem despejos de erros em bruto a ninguém.

Ferramentas de API: request_history.listusage.summary

09

Posso confiar no resultado dos modelos?

O resultado dos modelos pode conter erros e a Frely não garante a exatidão. Reveja-o antes de o utilizar em contextos críticos para a segurança, jurídicos, financeiros, médicos, de segurança ou de produção.