# API da ReOpenly

> Documentação da API e um arquivo Markdown por operação pública.

- [Quickstart](https://reopenly.com/docs/pt/quickstart/)
- [Embedding quickstart](https://reopenly.com/docs/pt/quickstart-embeddings/)
- [Interactive API reference](https://reopenly.com/docs/pt/api-reference/)
- [OpenAPI JSON](https://reopenly.com/docs/openapi/v1.pt.json)

## Operations

- [POST /api/projects/{owner_slug}/{project_slug}/openai/v1/chat/completions](https://reopenly.com/docs/agent-api/pt/createAChatCompletion.md): Criar uma resposta de chat
- [POST /api/projects/{owner_slug}/{project_slug}/openai/v1/completions](https://reopenly.com/docs/agent-api/pt/createATextCompletion.md): Criar uma continuação de texto
- [POST /api/projects/{owner_slug}/{project_slug}/openai/v1/embeddings](https://reopenly.com/docs/agent-api/pt/createEmbeddings.md): Criar embeddings
- [GET /api/projects/{owner_slug}/{project_slug}/openai/v1/models](https://reopenly.com/docs/agent-api/pt/listModels.md): Listar modelos
- [GET /api/v1/activity](https://reopenly.com/docs/agent-api/pt/listRecentActivity.md): Listar atividade recente
- [GET /api/v1/base-models](https://reopenly.com/docs/agent-api/pt/listBaseModelsAndTrainingBounds.md): Listar modelos base e limites de treinamento
- [GET /api/v1/credits](https://reopenly.com/docs/agent-api/pt/getYourCreditBalance.md): Obter seu saldo de créditos
- [POST /api/v1/credits/checkout](https://reopenly.com/docs/agent-api/pt/buyCredits.md): Comprar créditos
- [GET /api/v1/credits/checkout/status](https://reopenly.com/docs/agent-api/pt/getAPurchaseSStatus.md): Obter o status de uma compra
- [GET /api/v1/credits/usage](https://reopenly.com/docs/agent-api/pt/getAMonthlyUsageStatement.md): Obter o extrato de uso do mês
- [GET /api/v1/dashboard](https://reopenly.com/docs/agent-api/pt/getTheDashboardSummary.md): Obter o resumo do painel
- [GET /api/v1/keys](https://reopenly.com/docs/agent-api/pt/listApiKeys.md): Listar chaves de API
- [POST /api/v1/keys](https://reopenly.com/docs/agent-api/pt/createAnApiKey.md): Criar uma chave de API
- [DELETE /api/v1/keys/{key_id}](https://reopenly.com/docs/agent-api/pt/deleteAnApiKey.md): Excluir uma chave de API
- [PATCH /api/v1/keys/{key_id}/activate](https://reopenly.com/docs/agent-api/pt/activateAnApiKey.md): Ativar uma chave de API
- [PATCH /api/v1/keys/{key_id}/deactivate](https://reopenly.com/docs/agent-api/pt/deactivateAnApiKey.md): Desativar uma chave de API
- [GET /api/v1/me](https://reopenly.com/docs/agent-api/pt/getYourAccount.md): Obter sua conta
- [POST /api/v1/me/email](https://reopenly.com/docs/agent-api/pt/addAVerifiedEmail.md): Adicionar um email verificado
- [POST /api/v1/me/email/verification](https://reopenly.com/docs/agent-api/pt/sendAnEmailVerificationCode.md): Enviar um código de verificação de email
- [POST /api/v1/me/password](https://reopenly.com/docs/agent-api/pt/changeYourPassword.md): Alterar sua senha
- [GET /api/v1/me/preferences](https://reopenly.com/docs/agent-api/pt/getYourPrivacyChoices.md): Obter suas escolhas de privacidade
- [PUT /api/v1/me/preferences/advertising](https://reopenly.com/docs/agent-api/pt/setAdvertisingMeasurement.md): Definir mensuração de publicidade
- [PUT /api/v1/me/preferences/product-analytics](https://reopenly.com/docs/agent-api/pt/setProductAnalytics.md): Definir análise de produto
- [PATCH /api/v1/me/profile](https://reopenly.com/docs/agent-api/pt/changeYourDisplayName.md): Alterar seu nome de exibição
- [GET /api/v1/models](https://reopenly.com/docs/agent-api/pt/listEveryModelYouCanCall.md): Listar todos os modelos que você pode chamar
- [GET /api/v1/playground/sessions](https://reopenly.com/docs/agent-api/pt/listPlaygroundSessions.md): Listar sessões do playground
- [POST /api/v1/playground/sessions](https://reopenly.com/docs/agent-api/pt/saveAPlaygroundSession.md): Salvar uma sessão do playground
- [DELETE /api/v1/playground/sessions/{session_id}](https://reopenly.com/docs/agent-api/pt/deleteAPlaygroundSession.md): Excluir uma sessão do playground
- [GET /api/v1/playground/sessions/{session_id}](https://reopenly.com/docs/agent-api/pt/getAPlaygroundSession.md): Obter uma sessão do playground
- [PUT /api/v1/playground/sessions/{session_id}](https://reopenly.com/docs/agent-api/pt/updateAPlaygroundSession.md): Atualizar uma sessão do playground
- [POST /api/v1/pricing/estimate](https://reopenly.com/docs/agent-api/pt/estimateACost.md): Estimar um custo
- [GET /api/v1/pricing/models](https://reopenly.com/docs/agent-api/pt/getModelPrices.md): Obter preços dos modelos
- [GET /api/v1/pricing/platform](https://reopenly.com/docs/agent-api/pt/getPlatformPrices.md): Obter preços da plataforma
- [GET /api/v1/projects](https://reopenly.com/docs/agent-api/pt/listProjects.md): Listar projetos
- [POST /api/v1/projects](https://reopenly.com/docs/agent-api/pt/createAProject.md): Criar um projeto
- [GET /api/v1/projects/capabilities](https://reopenly.com/docs/agent-api/pt/listProjectTypes.md): Listar tipos de projeto
- [GET /api/v1/projects/{owner_slug}/{project_slug}](https://reopenly.com/docs/agent-api/pt/getAProject.md): Obter um projeto
- [PUT /api/v1/projects/{owner_slug}/{project_slug}](https://reopenly.com/docs/agent-api/pt/updateAProject.md): Atualizar um projeto
- [POST /api/v1/projects/{owner_slug}/{project_slug}/archive](https://reopenly.com/docs/agent-api/pt/archiveAProject.md): Arquivar um projeto
- [GET /api/v1/projects/{owner_slug}/{project_slug}/chats](https://reopenly.com/docs/agent-api/pt/listChats.md): Listar chats
- [POST /api/v1/projects/{owner_slug}/{project_slug}/chats](https://reopenly.com/docs/agent-api/pt/createAChat.md): Criar um chat
- [POST /api/v1/projects/{owner_slug}/{project_slug}/chats/bulk](https://reopenly.com/docs/agent-api/pt/createChatsInBulk.md): Criar chats em lote
- [GET /api/v1/projects/{owner_slug}/{project_slug}/chats/categories](https://reopenly.com/docs/agent-api/pt/listChatCategories.md): Listar categorias de chats
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/chats/{chat_id}](https://reopenly.com/docs/agent-api/pt/deleteAChat.md): Excluir um chat
- [GET /api/v1/projects/{owner_slug}/{project_slug}/chats/{chat_id}](https://reopenly.com/docs/agent-api/pt/getAChat.md): Obter um chat
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/chats/{chat_id}](https://reopenly.com/docs/agent-api/pt/updateAChat.md): Atualizar um chat
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets](https://reopenly.com/docs/agent-api/pt/listDatasets.md): Listar datasets
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets](https://reopenly.com/docs/agent-api/pt/createADataset.md): Criar um dataset
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/limits](https://reopenly.com/docs/agent-api/pt/getDatasetLimits.md): Obter limites do dataset
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}](https://reopenly.com/docs/agent-api/pt/renameADataset.md): Renomear um dataset
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/archive](https://reopenly.com/docs/agent-api/pt/archiveADataset.md): Arquivar um dataset
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples](https://reopenly.com/docs/agent-api/pt/listExamples.md): Listar exemplos
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples](https://reopenly.com/docs/agent-api/pt/addAnExample.md): Adicionar um exemplo
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples/tags](https://reopenly.com/docs/agent-api/pt/setExampleTags.md): Definir tags de exemplos
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples/{example_id}](https://reopenly.com/docs/agent-api/pt/deleteAnExample.md): Excluir um exemplo
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples/{example_id}](https://reopenly.com/docs/agent-api/pt/editAnExample.md): Editar um exemplo
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/imports](https://reopenly.com/docs/agent-api/pt/startAnImport.md): Iniciar uma importação
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events](https://reopenly.com/docs/agent-api/pt/listRecordedSearches.md): Listar buscas registradas
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events](https://reopenly.com/docs/agent-api/pt/recordASearch.md): Registrar uma busca
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/batch](https://reopenly.com/docs/agent-api/pt/recordSearchesInBulk.md): Registrar buscas em lote
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/{event_id}](https://reopenly.com/docs/agent-api/pt/getARecordedSearch.md): Obter uma busca registrada
- [PATCH /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/{event_id}](https://reopenly.com/docs/agent-api/pt/skipOrRestoreARecordedSearch.md): Ignorar ou restaurar uma busca registrada
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/{event_id}/promote](https://reopenly.com/docs/agent-api/pt/turnASearchIntoAnExample.md): Transformar uma busca em exemplo
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-settings](https://reopenly.com/docs/agent-api/pt/getFeedbackSettings.md): Obter configurações de feedback
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/tags](https://reopenly.com/docs/agent-api/pt/listDatasetTags.md): Listar tags do dataset
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/tags](https://reopenly.com/docs/agent-api/pt/createADatasetTag.md): Criar uma tag do dataset
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/unarchive](https://reopenly.com/docs/agent-api/pt/restoreAnArchivedDataset.md): Restaurar um dataset arquivado
- [GET /api/v1/projects/{owner_slug}/{project_slug}/imports](https://reopenly.com/docs/agent-api/pt/listImports.md): Listar importações
- [GET /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}](https://reopenly.com/docs/agent-api/pt/getAnImport.md): Obter uma importação
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/cancel](https://reopenly.com/docs/agent-api/pt/cancelAnImport.md): Cancelar uma importação
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/confirm](https://reopenly.com/docs/agent-api/pt/confirmAnImport.md): Confirmar uma importação
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/content](https://reopenly.com/docs/agent-api/pt/uploadTheImportFile.md): Enviar o arquivo da importação
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/preview](https://reopenly.com/docs/agent-api/pt/previewAColumnMapping.md): Visualizar um mapeamento de colunas
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/profile](https://reopenly.com/docs/agent-api/pt/readTheUploadedFile.md): Ler o arquivo enviado
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models](https://reopenly.com/docs/agent-api/pt/listHostedModels.md): Listar modelos hospedados
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models](https://reopenly.com/docs/agent-api/pt/hostAModel.md): Hospedar um modelo
- [PATCH /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}](https://reopenly.com/docs/agent-api/pt/updateAHostedModel.md): Atualizar um modelo hospedado
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}](https://reopenly.com/docs/agent-api/pt/updateAHostedModelPut.md): Atualizar um modelo hospedado
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/disable](https://reopenly.com/docs/agent-api/pt/disableAHostedModel.md): Desativar um modelo hospedado
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/download](https://reopenly.com/docs/agent-api/pt/downloadAnEmbeddingModel.md): Baixar um modelo de embeddings
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/download-metadata](https://reopenly.com/docs/agent-api/pt/describeAModelDownload.md): Descrever o download de um modelo
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/enable](https://reopenly.com/docs/agent-api/pt/enableAHostedModel.md): Ativar um modelo hospedado
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/shares](https://reopenly.com/docs/agent-api/pt/listShares.md): Listar compartilhamentos
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/shares](https://reopenly.com/docs/agent-api/pt/shareAModel.md): Compartilhar um modelo
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/shares/{share_id}](https://reopenly.com/docs/agent-api/pt/removeAShare.md): Remover um compartilhamento
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/target-compatibility](https://reopenly.com/docs/agent-api/pt/checkAReplacementEmbeddingModel.md): Verificar um modelo de embeddings substituto
- [POST /api/v1/projects/{owner_slug}/{project_slug}/playground/embeddings/similarity](https://reopenly.com/docs/agent-api/pt/scoreDocumentsAgainstAQuery.md): Pontuar documentos contra uma consulta
- [POST /api/v1/projects/{owner_slug}/{project_slug}/playground/embeddings/vector](https://reopenly.com/docs/agent-api/pt/embedTexts.md): Gerar embeddings de textos
- [GET /api/v1/projects/{owner_slug}/{project_slug}/search/corpora](https://reopenly.com/docs/agent-api/pt/listSearchDatasets.md): Listar conjuntos de dados da Busca
- [GET /api/v1/projects/{owner_slug}/{project_slug}/search/indexes](https://reopenly.com/docs/agent-api/pt/listSearchIndexes.md): Listar índices de Busca
- [POST /api/v1/projects/{owner_slug}/{project_slug}/search/indexes](https://reopenly.com/docs/agent-api/pt/buildASearchIndex.md): Criar um índice de Busca
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/search/indexes/{index_id}](https://reopenly.com/docs/agent-api/pt/deleteASearchIndex.md): Excluir um índice de Busca
- [POST /api/v1/projects/{owner_slug}/{project_slug}/search/indexes/{index_id}/cancel](https://reopenly.com/docs/agent-api/pt/stopASearchIndexBuild.md): Interromper a criação de um índice de Busca
- [POST /api/v1/projects/{owner_slug}/{project_slug}/search/indexes/{index_id}/query](https://reopenly.com/docs/agent-api/pt/queryASearchIndex.md): Consultar um índice de Busca
- [GET /api/v1/projects/{owner_slug}/{project_slug}/search/versions](https://reopenly.com/docs/agent-api/pt/listIndexableDatasetVersions.md): Listar versões de dataset indexáveis
- [GET /api/v1/projects/{owner_slug}/{project_slug}/tags](https://reopenly.com/docs/agent-api/pt/listChatTags.md): Listar tags de chats
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs](https://reopenly.com/docs/agent-api/pt/listTrainingJobs.md): Listar jobs de treinamento
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs](https://reopenly.com/docs/agent-api/pt/startATrainingJob.md): Iniciar um job de treinamento
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/estimate](https://reopenly.com/docs/agent-api/pt/estimateAnEmbeddingRun.md): Estimar uma execução de embeddings
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/estimate-messages](https://reopenly.com/docs/agent-api/pt/estimateATextRun.md): Estimar uma execução de texto
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/preview](https://reopenly.com/docs/agent-api/pt/previewAnEmbeddingRun.md): Visualizar uma execução de embeddings
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/profiles](https://reopenly.com/docs/agent-api/pt/listEmbeddingTrainingProfiles.md): Listar perfis de treinamento de embeddings
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}](https://reopenly.com/docs/agent-api/pt/getATrainingJob.md): Obter um job de treinamento
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/attempts](https://reopenly.com/docs/agent-api/pt/listAJobSAttempts.md): Listar as tentativas de um job
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/attempts/{attempt_id}/logs](https://reopenly.com/docs/agent-api/pt/streamAnAttemptSLog.md): Transmitir o log de uma tentativa
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/cancel](https://reopenly.com/docs/agent-api/pt/cancelATrainingJob.md): Cancelar um job de treinamento
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/dataset](https://reopenly.com/docs/agent-api/pt/readAJobSFrozenDataset.md): Ler o dataset congelado de um job
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/dataset/{chat_id}](https://reopenly.com/docs/agent-api/pt/readOneFrozenChat.md): Ler um chat congelado
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/download](https://reopenly.com/docs/agent-api/pt/downloadTheTrainedAdapter.md): Baixar o adaptador treinado
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/download-metadata](https://reopenly.com/docs/agent-api/pt/describeAJobSDownload.md): Descrever o download de um job
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/finish](https://reopenly.com/docs/agent-api/pt/keepAPausedJobSModel.md): Ficar com o modelo de um job pausado
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/pause](https://reopenly.com/docs/agent-api/pt/pauseATrainingJob.md): Pausar um job de treinamento
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/resume](https://reopenly.com/docs/agent-api/pt/resumeAPausedJob.md): Retomar um job pausado
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/retry](https://reopenly.com/docs/agent-api/pt/retryATrainingJob.md): Tentar de novo um job de treinamento
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/retry-estimate](https://reopenly.com/docs/agent-api/pt/estimateARetry.md): Estimar uma nova tentativa
- [POST /api/v1/projects/{owner_slug}/{project_slug}/unarchive](https://reopenly.com/docs/agent-api/pt/restoreAnArchivedProject.md): Restaurar um projeto arquivado