# GenAI Docs

## Docs

- [Error Codes](https://docs.genai.scale.com/api-reference/error-codes.md): Common error codes returned by the API.
- [Expanding Entities](https://docs.genai.scale.com/api-reference/expanding-entities.md): Expand certain entities within the API response.
- [Idempotent Requests](https://docs.genai.scale.com/api-reference/idempotency.md): Idempotency for task creation endpoints.
- [Introduction](https://docs.genai.scale.com/api-reference/introduction.md)
- [Start an evaluation job](https://docs.genai.scale.com/auto-evaluation/autoevals.md): Submits an evaluation job for a model version config.
- [Retrieve evaluation jobs for a Model Version Config](https://docs.genai.scale.com/auto-evaluation/model-statuses.md)
- [Retrieve evaluation results](https://docs.genai.scale.com/auto-evaluation/results.md): Fetches the results of a completed or in-progress evaluation job. Accuracy, histogram, and errored response count values are only available for completed jobs.
- [Retry an evaluation job](https://docs.genai.scale.com/auto-evaluation/retry.md): Retries an evaluation job.
- [Retrieve evaluation job details](https://docs.genai.scale.com/auto-evaluation/status.md): Fetches the details of a specific evaluation job.
- [Retrieve statuses of all evaluation jobs](https://docs.genai.scale.com/auto-evaluation/statuses.md): Fetches the status of all evaluation jobs.
- [Terminate an evaluation job](https://docs.genai.scale.com/auto-evaluation/terminate.md): Terminates an evaluation job.
- [Annotation](https://docs.genai.scale.com/core-resources/annotation.md): An Annotation represent a piece of labeled data.
- [Batch](https://docs.genai.scale.com/core-resources/batch.md): Batches organize [Tasks](/core-resources/task) within a [Project](/core-resources/project).
- [Chunk](https://docs.genai.scale.com/core-resources/chunk.md): A Chunk is a piece of content and [Annotations](/core-resources/annotation) that are relevant to that Chunk.
- [Dataset](https://docs.genai.scale.com/core-resources/dataset.md): Pre-built collections of data created by subject matter experts to accelerate model development.
- [Dataset delivery](https://docs.genai.scale.com/core-resources/dataset-delivery.md): Deliveries represent a group of delivered [Dataset Tasks](/core-resources/dataset-task) within a [Dataset](/core-resources/dataset).
- [Dataset task](https://docs.genai.scale.com/core-resources/dataset-task.md): A Dataset Task represents an individual unit of data in a dataset.
- [Delivery](https://docs.genai.scale.com/core-resources/delivery.md): Deliveries represent a group of delivered [Tasks](/core-resources/task) within a [Project](/core-resources/project).
- [Message](https://docs.genai.scale.com/core-resources/message.md): A Message is a piece of content and [Annotations](/core-resources/annotation) that are relevant to that Message.
- [Project](https://docs.genai.scale.com/core-resources/project.md): Projects are the root nodes of Scale's information hierarchy. [Tasks](/core-resources/task) belong to a Project.
- [Task](https://docs.genai.scale.com/core-resources/task.md): A Task represents an individual unit of work done by a contributor.
- [Thread](https://docs.genai.scale.com/core-resources/thread.md): A Thread is a series of [Turns](/core-resources/turn) and [Annotations](/core-resources/annotation) that are relevant to the entire Thread.
- [Turn](https://docs.genai.scale.com/core-resources/turn.md): A Turn is a series of [Messages](/core-resources/message) and [Annotations](/core-resources/annotation) that are relevant to the Turn.
- [Authentication](https://docs.genai.scale.com/get-started/authentication.md)
- [Quickstart](https://docs.genai.scale.com/get-started/quickstart.md): How to use Scale APIs
- [Retrieve all models](https://docs.genai.scale.com/model-management/model-endpoints.md): Fetches a list of all available models.
- [Search Model Version Configs](https://docs.genai.scale.com/model-management/model-version-config-get.md): Fetches a list of all registered model version configs for a given Model Endpoint.
- [Upload a new Model Version Config](https://docs.genai.scale.com/model-management/model-version-config-post.md): Create a new Model Version Config to be evaluated.
- [Retrieve a Model Version Config](https://docs.genai.scale.com/model-management/model-version-configs.md): Fetches details of a specific Model Version Config.
- [Evals](https://docs.genai.scale.com/project-archetypes/evals.md): Model Evaluation
- [Introduction](https://docs.genai.scale.com/project-archetypes/introduction.md)
- [RLHF](https://docs.genai.scale.com/project-archetypes/rlhf.md): Reinforcement Learning from Human Feedback
- [Rubrics](https://docs.genai.scale.com/project-archetypes/rubrics.md): Contributor defined rating criteria
- [SFT](https://docs.genai.scale.com/project-archetypes/sft.md): Supervised Fine-Tuning
- [Get Task (legacy)](https://docs.genai.scale.com/v1/task.md)
- [Get an Annotation](https://docs.genai.scale.com/v2/annotation.md): Retrieve an [Annotation](/core-resources/annotation) from its `id`.
- [Get a Batch](https://docs.genai.scale.com/v2/batch.md): Retrieve a [Batch](/core-resources/batch) from its `batch_id` or `batch_name`.
- [Cancel a Batch](https://docs.genai.scale.com/v2/batch-cancel.md): Cancel processing of a [Batch](/core-resources/batch). Unstarted tasks will be cancelled. Completed batches cannot be cancelled.
- [Create a Batch](https://docs.genai.scale.com/v2/batch-create.md): Create a new [Batch](/core-resources/batch) for organizing tasks.
- [Finalize a Batch](https://docs.genai.scale.com/v2/batch-finalize.md): Move a [Batch](/core-resources/batch) from staging to in-progress status to begin processing tasks.
- [Pause a Batch](https://docs.genai.scale.com/v2/batch-pause.md): Pause processing of an in-progress [Batch](/core-resources/batch). Only unstarted tasks will be paused.
- [Resume a Batch](https://docs.genai.scale.com/v2/batch-resume.md): Resume processing of a paused [Batch](/core-resources/batch). Previously paused tasks will be resumed.
- [Set Batch Metadata](https://docs.genai.scale.com/v2/batch-set-metadata.md): Update the metadata for a [Batch](/core-resources/batch).
- [Get Multiple Batches](https://docs.genai.scale.com/v2/batches.md): Retrieve multiple [Batches](/core-resources/batch) from a [Project](/core-resources/project).
- [List Datasets](https://docs.genai.scale.com/v2/datasets.md): Retrieve a list of delivered [Datasets](/core-resources/dataset) with their IDs and names.
- [List All Dataset Deliveries](https://docs.genai.scale.com/v2/datasets/deliveries.md): Lists of [Deliveries](/core-resources/dataset-delivery) from datasets.
- [Get Dataset Tasks in a Delivery](https://docs.genai.scale.com/v2/datasets/delivery.md): Retrieve multiple [Dataset Tasks](/core-resources/dataset-task) from a [Delivery](/core-resources/dataset-delivery).
- [Get Response Attachment](https://docs.genai.scale.com/v2/datasets/response_url.md): Retrieve a [Dataset Task](/core-resources/dataset-task) response attachment. Response attachment URLs can be found in the `response` object of a [Dataset Task](/core-resources/dataset-task) and only exist in some datasets.
- [Get a Dataset Task](https://docs.genai.scale.com/v2/datasets/task.md): Retrieve a [Dataset Task](/core-resources/dataset-task) from its `task_id`.
- [Get Multiple Dataset Tasks](https://docs.genai.scale.com/v2/datasets/tasks.md): Retrieve multiple [Dataset Tasks](/core-resources/dataset-task) from a [Dataset](/core-resources/dataset) or [Delivery](/core-resources/dataset-delivery).
- [List All Deliveries](https://docs.genai.scale.com/v2/deliveries.md): Lists of [Deliveries](/core-resources/delivery) from a [Project](/core-resources/project).
- [Get Tasks in a Delivery](https://docs.genai.scale.com/v2/delivery.md): Retrieve multiple [Tasks](/core-resources/task) from a [Delivery](/core-resources/delivery).
- [Get Delivered Task Responses](https://docs.genai.scale.com/v2/delivery-tasks.md): Retrieve delivered [Task](/core-resources/task) response data from a [Project](/core-resources/project), optionally filtered by [Delivery](/core-resources/delivery).
- [Get a Project](https://docs.genai.scale.com/v2/project.md): Retrieve a [Project](/core-resources/project) from its `project_id` or `project_name`.
- [Get Multiple Projects](https://docs.genai.scale.com/v2/projects.md): Retrieve multiple [Projects](/core-resources/project).
- [Get a Delivery JSON Schema](https://docs.genai.scale.com/v2/schema.md): Retrieve a delivery JSON schema by its unique identifier. Delivery JSON schemas define the structure and validation rules for task responses.
- [Get a Task](https://docs.genai.scale.com/v2/task.md): Retrieve a [Task](/core-resources/task) from its `task_id`.
- [Create a Chat Task](https://docs.genai.scale.com/v2/task-chat-create.md): Create a new [Task](/core-resources/task) for GenAI projects. Uses structured task templates, not free-form instructions.
- [Set Task Metadata](https://docs.genai.scale.com/v2/task-set-metadata.md): Update the metadata for a [Task](/core-resources/task).
- [Get Multiple Tasks](https://docs.genai.scale.com/v2/tasks.md): Retrieve multiple [Tasks](/core-resources/task) from a [Project](/core-resources/project) or [Batch](/core-resources/batch).

## OpenAPI Specs

- [openapi](https://docs.genai.scale.com/openapi.yaml)