Especificação da API
Referência para integrações em fluxos de trabalho de texto, agentes, multimédia e recuperação de informação.
https://cicora.ai/api/v1https://cicora.ai/apiReferência de integração: escolha os parâmetros e as capacidades disponíveis nas definições da API da sua conta e no catálogo de modelos do seu ambiente.
Enviar um primeiro pedidoComeçar
Envie um primeiro pedido, selecione um modelo no catálogo e conserve um identificador do pedido para diagnóstico.
AutenticaçãoEnvie uma chave de API num cabeçalho Bearer e mantenha as credenciais de produção separadas das de desenvolvimento.
SDK e clientes HTTPUse URLs base diferentes para clientes de estilo OpenAI e Messages: visam uma especificação, mas compõem os caminhos de forma diferente.
CLI e integraçõesConfigure um cliente com uma chave, um modelo e um URL base adequado ao respetivo protocolo; mantenha o segredo no ambiente.
Perguntas frequentes para programadoresRespostas práticas e breves sobre chaves, URLs base, modelos, custos e diagnóstico de integrações.
Conta e catálogo
Construa a seleção de modelos com dados do catálogo, e não com uma lista fixa na aplicação.
Equipas e chaves de APISepare chaves, proprietários, orçamentos e rastreios de utilização entre aplicações e espaços de trabalho.
LimitesConsidere os limites da chave, da organização, do modelo e do encaminhamento como parte do fluxo do utilizador.
Utilização e custoAssocie os metadados da resposta e os seus próprios registos de pedidos a ações reais dos utilizadores.
Dados e privacidadeMinimize os dados transmitidos, separe do conteúdo o identificador do utilizador final e controle a retenção no seu produto.
Texto e agentes
Crie conversas de vários turnos no formato messages habitual e selecione um modelo para cada pedido.
API MessagesUse o formato Messages para conversas com uma instrução de sistema de nível superior e um limite de saída explícito.
API ResponsesUse um objeto de entrada quando a sua aplicação beneficiar de tratar itens de saída e ações num único modelo de dados.
TransmissãoReceba tokens e incrementos estruturados por SSE sem esperar pela resposta completa.
Ferramentas e chamadas de funçõesDescreva funções com esquema JSON, execute a chamada na aplicação e devolva o resultado à conversa.
Saídas estruturadasPeça um objeto JSON ou um esquema JSON quando a resposta se destinar a software e não a uma pessoa.
RaciocínioDefina o esforço de raciocínio por pedido apenas para modelos que declarem essa capacidade.
EncaminhamentoExpresse os requisitos de execução nas preferências do fornecedor e conserve o resultado efetivo para observabilidade.
Cache de contextoSepare o contexto recorrente, para o cliente poder usar cache compatível quando o modelo escolhido a suportar.
Pesquisa na WebRecupere fontes recentes através de uma função `web_search` executada pelo cliente e mantenha as ligações separadas do texto gerado.
Multimédia e recuperação
Carregue um ficheiro através de uma operação própria, conserve o respetivo ID e passe uma referência num pedido compatível posterior.
ImagensCrie imagens através de uma única rota e selecione parâmetros entre as capacidades do modelo escolhido.
VídeoInicie o vídeo como tarefa assíncrona, conserve o respetivo ID e mantenha a criação separada da leitura do resultado.
ÁudioUse operações separadas para síntese de voz, transcrição e entrada de áudio num modelo.
EmbeddingsTransforme texto ou entradas compatíveis em vetores para pesquisa, agrupamento e recomendações.
ReordenaçãoReordene um pequeno conjunto de candidatos em função de uma consulta para melhorar a precisão da recuperação final.
Execução em loteProcesse operações independentes em grupos controlados quando o fluxo de trabalho permitir entrega assíncrona.