# ReOpenly API

> Customer API documentation and one Markdown file per public operation.

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

## Operations

- [POST /api/projects/{owner_slug}/{project_slug}/openai/v1/chat/completions](https://reopenly.com/docs/agent-api/en/createAChatCompletion.md): Create a chat completion
- [POST /api/projects/{owner_slug}/{project_slug}/openai/v1/completions](https://reopenly.com/docs/agent-api/en/createATextCompletion.md): Create a text completion
- [POST /api/projects/{owner_slug}/{project_slug}/openai/v1/embeddings](https://reopenly.com/docs/agent-api/en/createEmbeddings.md): Create embeddings
- [GET /api/projects/{owner_slug}/{project_slug}/openai/v1/models](https://reopenly.com/docs/agent-api/en/listModels.md): List models
- [GET /api/v1/activity](https://reopenly.com/docs/agent-api/en/listRecentActivity.md): List recent activity
- [GET /api/v1/base-models](https://reopenly.com/docs/agent-api/en/listBaseModelsAndTrainingBounds.md): List base models and training bounds
- [GET /api/v1/credits](https://reopenly.com/docs/agent-api/en/getYourCreditBalance.md): Get your credit balance
- [POST /api/v1/credits/checkout](https://reopenly.com/docs/agent-api/en/buyCredits.md): Buy credits
- [GET /api/v1/credits/checkout/status](https://reopenly.com/docs/agent-api/en/getAPurchaseSStatus.md): Get a purchase's status
- [GET /api/v1/credits/usage](https://reopenly.com/docs/agent-api/en/getAMonthlyUsageStatement.md): Get a monthly usage statement
- [GET /api/v1/dashboard](https://reopenly.com/docs/agent-api/en/getTheDashboardSummary.md): Get the dashboard summary
- [GET /api/v1/keys](https://reopenly.com/docs/agent-api/en/listApiKeys.md): List API keys
- [POST /api/v1/keys](https://reopenly.com/docs/agent-api/en/createAnApiKey.md): Create an API key
- [DELETE /api/v1/keys/{key_id}](https://reopenly.com/docs/agent-api/en/deleteAnApiKey.md): Delete an API key
- [PATCH /api/v1/keys/{key_id}/activate](https://reopenly.com/docs/agent-api/en/activateAnApiKey.md): Activate an API key
- [PATCH /api/v1/keys/{key_id}/deactivate](https://reopenly.com/docs/agent-api/en/deactivateAnApiKey.md): Deactivate an API key
- [GET /api/v1/me](https://reopenly.com/docs/agent-api/en/getYourAccount.md): Get your account
- [POST /api/v1/me/email](https://reopenly.com/docs/agent-api/en/addAVerifiedEmail.md): Add a verified email
- [POST /api/v1/me/email/verification](https://reopenly.com/docs/agent-api/en/sendAnEmailVerificationCode.md): Send an email verification code
- [POST /api/v1/me/password](https://reopenly.com/docs/agent-api/en/changeYourPassword.md): Change your password
- [GET /api/v1/me/preferences](https://reopenly.com/docs/agent-api/en/getYourPrivacyChoices.md): Get your privacy choices
- [PUT /api/v1/me/preferences/advertising](https://reopenly.com/docs/agent-api/en/setAdvertisingMeasurement.md): Set advertising measurement
- [PUT /api/v1/me/preferences/product-analytics](https://reopenly.com/docs/agent-api/en/setProductAnalytics.md): Set product analytics
- [PATCH /api/v1/me/profile](https://reopenly.com/docs/agent-api/en/changeYourDisplayName.md): Change your display name
- [GET /api/v1/models](https://reopenly.com/docs/agent-api/en/listEveryModelYouCanCall.md): List every model you can call
- [GET /api/v1/playground/sessions](https://reopenly.com/docs/agent-api/en/listPlaygroundSessions.md): List playground sessions
- [POST /api/v1/playground/sessions](https://reopenly.com/docs/agent-api/en/saveAPlaygroundSession.md): Save a playground session
- [DELETE /api/v1/playground/sessions/{session_id}](https://reopenly.com/docs/agent-api/en/deleteAPlaygroundSession.md): Delete a playground session
- [GET /api/v1/playground/sessions/{session_id}](https://reopenly.com/docs/agent-api/en/getAPlaygroundSession.md): Get a playground session
- [PUT /api/v1/playground/sessions/{session_id}](https://reopenly.com/docs/agent-api/en/updateAPlaygroundSession.md): Update a playground session
- [POST /api/v1/pricing/estimate](https://reopenly.com/docs/agent-api/en/estimateACost.md): Estimate a cost
- [GET /api/v1/pricing/models](https://reopenly.com/docs/agent-api/en/getModelPrices.md): Get model prices
- [GET /api/v1/pricing/platform](https://reopenly.com/docs/agent-api/en/getPlatformPrices.md): Get platform prices
- [GET /api/v1/projects](https://reopenly.com/docs/agent-api/en/listProjects.md): List projects
- [POST /api/v1/projects](https://reopenly.com/docs/agent-api/en/createAProject.md): Create a project
- [GET /api/v1/projects/capabilities](https://reopenly.com/docs/agent-api/en/listProjectTypes.md): List project types
- [GET /api/v1/projects/{owner_slug}/{project_slug}](https://reopenly.com/docs/agent-api/en/getAProject.md): Get a project
- [PUT /api/v1/projects/{owner_slug}/{project_slug}](https://reopenly.com/docs/agent-api/en/updateAProject.md): Update a project
- [POST /api/v1/projects/{owner_slug}/{project_slug}/archive](https://reopenly.com/docs/agent-api/en/archiveAProject.md): Archive a project
- [GET /api/v1/projects/{owner_slug}/{project_slug}/chats](https://reopenly.com/docs/agent-api/en/listChats.md): List chats
- [POST /api/v1/projects/{owner_slug}/{project_slug}/chats](https://reopenly.com/docs/agent-api/en/createAChat.md): Create a chat
- [POST /api/v1/projects/{owner_slug}/{project_slug}/chats/bulk](https://reopenly.com/docs/agent-api/en/createChatsInBulk.md): Create chats in bulk
- [GET /api/v1/projects/{owner_slug}/{project_slug}/chats/categories](https://reopenly.com/docs/agent-api/en/listChatCategories.md): List chat categories
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/chats/{chat_id}](https://reopenly.com/docs/agent-api/en/deleteAChat.md): Delete a chat
- [GET /api/v1/projects/{owner_slug}/{project_slug}/chats/{chat_id}](https://reopenly.com/docs/agent-api/en/getAChat.md): Get a chat
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/chats/{chat_id}](https://reopenly.com/docs/agent-api/en/updateAChat.md): Update a chat
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets](https://reopenly.com/docs/agent-api/en/listDatasets.md): List datasets
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets](https://reopenly.com/docs/agent-api/en/createADataset.md): Create a dataset
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/limits](https://reopenly.com/docs/agent-api/en/getDatasetLimits.md): Get dataset limits
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}](https://reopenly.com/docs/agent-api/en/renameADataset.md): Rename a dataset
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/archive](https://reopenly.com/docs/agent-api/en/archiveADataset.md): Archive a dataset
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples](https://reopenly.com/docs/agent-api/en/listExamples.md): List examples
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples](https://reopenly.com/docs/agent-api/en/addAnExample.md): Add an example
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples/tags](https://reopenly.com/docs/agent-api/en/setExampleTags.md): Set example tags
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples/{example_id}](https://reopenly.com/docs/agent-api/en/deleteAnExample.md): Delete an example
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/examples/{example_id}](https://reopenly.com/docs/agent-api/en/editAnExample.md): Edit an example
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/imports](https://reopenly.com/docs/agent-api/en/startAnImport.md): Start an import
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events](https://reopenly.com/docs/agent-api/en/listRecordedSearches.md): List recorded searches
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events](https://reopenly.com/docs/agent-api/en/recordASearch.md): Record a search
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/batch](https://reopenly.com/docs/agent-api/en/recordSearchesInBulk.md): Record searches in bulk
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/{event_id}](https://reopenly.com/docs/agent-api/en/getARecordedSearch.md): Get a recorded search
- [PATCH /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/{event_id}](https://reopenly.com/docs/agent-api/en/skipOrRestoreARecordedSearch.md): Skip or restore a recorded search
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-events/{event_id}/promote](https://reopenly.com/docs/agent-api/en/turnASearchIntoAnExample.md): Turn a search into an example
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/retrieval-settings](https://reopenly.com/docs/agent-api/en/getFeedbackSettings.md): Get feedback settings
- [GET /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/tags](https://reopenly.com/docs/agent-api/en/listDatasetTags.md): List dataset tags
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/tags](https://reopenly.com/docs/agent-api/en/createADatasetTag.md): Create a dataset tag
- [POST /api/v1/projects/{owner_slug}/{project_slug}/datasets/{dataset_id}/unarchive](https://reopenly.com/docs/agent-api/en/restoreAnArchivedDataset.md): Restore an archived dataset
- [GET /api/v1/projects/{owner_slug}/{project_slug}/imports](https://reopenly.com/docs/agent-api/en/listImports.md): List imports
- [GET /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}](https://reopenly.com/docs/agent-api/en/getAnImport.md): Get an import
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/cancel](https://reopenly.com/docs/agent-api/en/cancelAnImport.md): Cancel an import
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/confirm](https://reopenly.com/docs/agent-api/en/confirmAnImport.md): Confirm an import
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/content](https://reopenly.com/docs/agent-api/en/uploadTheImportFile.md): Upload the import file
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/preview](https://reopenly.com/docs/agent-api/en/previewAColumnMapping.md): Preview a column mapping
- [POST /api/v1/projects/{owner_slug}/{project_slug}/imports/{import_id}/profile](https://reopenly.com/docs/agent-api/en/readTheUploadedFile.md): Read the uploaded file
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models](https://reopenly.com/docs/agent-api/en/listHostedModels.md): List hosted models
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models](https://reopenly.com/docs/agent-api/en/hostAModel.md): Host a model
- [PATCH /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}](https://reopenly.com/docs/agent-api/en/updateAHostedModel.md): Update a hosted model
- [PUT /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}](https://reopenly.com/docs/agent-api/en/updateAHostedModelPut.md): Update a hosted model
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/disable](https://reopenly.com/docs/agent-api/en/disableAHostedModel.md): Disable a hosted model
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/download](https://reopenly.com/docs/agent-api/en/downloadAnEmbeddingModel.md): Download an embedding model
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/download-metadata](https://reopenly.com/docs/agent-api/en/describeAModelDownload.md): Describe a model download
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/enable](https://reopenly.com/docs/agent-api/en/enableAHostedModel.md): Enable a hosted model
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/shares](https://reopenly.com/docs/agent-api/en/listShares.md): List shares
- [POST /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/shares](https://reopenly.com/docs/agent-api/en/shareAModel.md): Share a model
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/shares/{share_id}](https://reopenly.com/docs/agent-api/en/removeAShare.md): Remove a share
- [GET /api/v1/projects/{owner_slug}/{project_slug}/models/{model_slug}/target-compatibility](https://reopenly.com/docs/agent-api/en/checkAReplacementEmbeddingModel.md): Check a replacement embedding model
- [POST /api/v1/projects/{owner_slug}/{project_slug}/playground/embeddings/similarity](https://reopenly.com/docs/agent-api/en/scoreDocumentsAgainstAQuery.md): Score documents against a query
- [POST /api/v1/projects/{owner_slug}/{project_slug}/playground/embeddings/vector](https://reopenly.com/docs/agent-api/en/embedTexts.md): Embed texts
- [GET /api/v1/projects/{owner_slug}/{project_slug}/search/corpora](https://reopenly.com/docs/agent-api/en/listSearchDatasets.md): List Search datasets
- [GET /api/v1/projects/{owner_slug}/{project_slug}/search/indexes](https://reopenly.com/docs/agent-api/en/listSearchIndexes.md): List Search indexes
- [POST /api/v1/projects/{owner_slug}/{project_slug}/search/indexes](https://reopenly.com/docs/agent-api/en/buildASearchIndex.md): Build a Search index
- [DELETE /api/v1/projects/{owner_slug}/{project_slug}/search/indexes/{index_id}](https://reopenly.com/docs/agent-api/en/deleteASearchIndex.md): Delete a Search index
- [POST /api/v1/projects/{owner_slug}/{project_slug}/search/indexes/{index_id}/cancel](https://reopenly.com/docs/agent-api/en/stopASearchIndexBuild.md): Stop a Search index build
- [POST /api/v1/projects/{owner_slug}/{project_slug}/search/indexes/{index_id}/query](https://reopenly.com/docs/agent-api/en/queryASearchIndex.md): Query a Search index
- [GET /api/v1/projects/{owner_slug}/{project_slug}/search/versions](https://reopenly.com/docs/agent-api/en/listIndexableDatasetVersions.md): List indexable dataset versions
- [GET /api/v1/projects/{owner_slug}/{project_slug}/tags](https://reopenly.com/docs/agent-api/en/listChatTags.md): List chat tags
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs](https://reopenly.com/docs/agent-api/en/listTrainingJobs.md): List training jobs
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs](https://reopenly.com/docs/agent-api/en/startATrainingJob.md): Start a training job
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/estimate](https://reopenly.com/docs/agent-api/en/estimateAnEmbeddingRun.md): Estimate an embedding run
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/estimate-messages](https://reopenly.com/docs/agent-api/en/estimateATextRun.md): Estimate a text run
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/preview](https://reopenly.com/docs/agent-api/en/previewAnEmbeddingRun.md): Preview an embedding run
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/profiles](https://reopenly.com/docs/agent-api/en/listEmbeddingTrainingProfiles.md): List embedding training profiles
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}](https://reopenly.com/docs/agent-api/en/getATrainingJob.md): Get a training job
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/attempts](https://reopenly.com/docs/agent-api/en/listAJobSAttempts.md): List a job's attempts
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/attempts/{attempt_id}/logs](https://reopenly.com/docs/agent-api/en/streamAnAttemptSLog.md): Stream an attempt's log
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/cancel](https://reopenly.com/docs/agent-api/en/cancelATrainingJob.md): Cancel a training job
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/dataset](https://reopenly.com/docs/agent-api/en/readAJobSFrozenDataset.md): Read a job's frozen dataset
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/dataset/{chat_id}](https://reopenly.com/docs/agent-api/en/readOneFrozenChat.md): Read one frozen chat
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/download](https://reopenly.com/docs/agent-api/en/downloadTheTrainedAdapter.md): Download the trained adapter
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/download-metadata](https://reopenly.com/docs/agent-api/en/describeAJobSDownload.md): Describe a job's download
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/finish](https://reopenly.com/docs/agent-api/en/keepAPausedJobSModel.md): Keep a paused job's model
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/pause](https://reopenly.com/docs/agent-api/en/pauseATrainingJob.md): Pause a training job
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/resume](https://reopenly.com/docs/agent-api/en/resumeAPausedJob.md): Resume a paused job
- [POST /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/retry](https://reopenly.com/docs/agent-api/en/retryATrainingJob.md): Retry a training job
- [GET /api/v1/projects/{owner_slug}/{project_slug}/training-jobs/{job_id}/retry-estimate](https://reopenly.com/docs/agent-api/en/estimateARetry.md): Estimate a retry
- [POST /api/v1/projects/{owner_slug}/{project_slug}/unarchive](https://reopenly.com/docs/agent-api/en/restoreAnArchivedProject.md): Restore an archived project