# Borza API

Borza API providing various endpoints for tasks management

Version: 1.0
License: MIT

## Servers

Production server
```
https://api.borza.com
```

Testing server
```
https://api-testing.borza.com
```

## Security

### APIKeyHeader

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Borza API](https://docs.borza.com/_bundle/openapi.yaml)

## Tasks

Operations related to **Tasks**. Create, update, and manage tasks.

### List Tasks

 - [GET /v1/tasks](https://docs.borza.com/openapi/tasks/list_tasks_v1_tasks_get.md): Retrieve a list of all tasks

### Create Task

 - [POST /v1/tasks](https://docs.borza.com/openapi/tasks/create_task_v1_tasks_post.md): Create a draft task

### List Filters

 - [GET /v1/tasks/filters](https://docs.borza.com/openapi/tasks/list_filters_v1_tasks_filters_get.md): Retrieve a list of all task filters

### Get Task

 - [GET /v1/tasks/{task_id}](https://docs.borza.com/openapi/tasks/get_task_v1_tasks__task_id__get.md): Retrieve a single task by its ID

### Full Update Task

 - [PUT /v1/tasks/{task_id}](https://docs.borza.com/openapi/tasks/full_update_task_v1_tasks__task_id__put.md): Full update an existing task by its ID

### Partial Update Task

 - [PATCH /v1/tasks/{task_id}](https://docs.borza.com/openapi/tasks/partial_update_task_v1_tasks__task_id__patch.md): Partial update an existing task by its ID

### Close Api

 - [DELETE /v1/tasks/{task_id}](https://docs.borza.com/openapi/tasks/close_api_v1_tasks__task_id__delete.md): Close a task by updating its status to 'Unavailable'.

### List Task Submissions

 - [GET /v1/tasks/{task_id}/submissions](https://docs.borza.com/openapi/tasks/list_task_submissions_v1_tasks__task_id__submissions_get.md): Retrieve all submissions for a specific task.

### Pause Task

 - [PUT /v1/tasks/{task_id}/pause](https://docs.borza.com/openapi/tasks/pause_task_v1_tasks__task_id__pause_put.md): Pause a task by updating its status to 'Draft'.

### Publish Task

 - [POST /v1/tasks/{task_id}/publish](https://docs.borza.com/openapi/tasks/publish_task_v1_tasks__task_id__publish_post.md): Publish a task by updating its publish status

### Calculate Estimate

 - [POST /v1/tasks/estimate/calculate](https://docs.borza.com/openapi/tasks/calculate_estimate_v1_tasks_estimate_calculate_post.md): Calculate cost estimate for a task:
- budget_per_task: base pay per talent
- bonus: bonus per talent
- participants: expected number of talents

### Get Task Cost Estimate

 - [GET /v1/tasks/{task_id}/cost-estimate](https://docs.borza.com/openapi/tasks/get_task_cost_estimate_v1_tasks__task_id__cost_estimate_get.md): Retrieve the cost estimate fields stored for a specific task.
This endpoint returns the fields exactly as saved (no calculations).

## Workspaces

Operations related to **Workspaces**. Create, update, and manage workspaces.

### List Workspaces

 - [GET /v1/workspaces](https://docs.borza.com/openapi/workspaces/list_workspaces_v1_workspaces_get.md): Retrieves workspace records linked to the API account.

### Get Workspace

 - [GET /v1/workspaces/{id}](https://docs.borza.com/openapi/workspaces/get_workspace_v1_workspaces__id__get.md): Get a workspace record using id

### Get Tasks

 - [GET /v1/workspaces/{id}/tasks](https://docs.borza.com/openapi/workspaces/get_tasks_v1_workspaces__id__tasks_get.md): Get tasks using workspace id

Args:
    id (str): The ID of the workspace to retrieve.

## Submissions

Opewrations related to **Submissions**. Create, update, and manage submissions.

### Get Submission By Id

 - [GET /v1/submissions/{submission_id}](https://docs.borza.com/openapi/submissions/get_submission_by_id_v1_submissions__submission_id__get.md): Retrieve a submission by its ID.

### Get Submissions By Task Id

 - [GET /v1/submissions/task/{task_id}](https://docs.borza.com/openapi/submissions/get_submissions_by_task_id_v1_submissions_task__task_id__get.md): Retrieve submission by assiociated task ID.

### Approve Submission

 - [POST /v1/submissions/{submission_id}/approve](https://docs.borza.com/openapi/submissions/approve_submission_v1_submissions__submission_id__approve_post.md): Approve a submission by updating its completion status to 'Approved'.

If a bonus amount is provided, it will be added to the submission record.

### Reject Submission

 - [POST /v1/submissions/{submission_id}/reject](https://docs.borza.com/openapi/submissions/reject_submission_v1_submissions__submission_id__reject_post.md): Reject a submission by updating its completion status to 'Rejected'.

### Await Review Submission

 - [POST /v1/submissions/{submission_id}/await-review](https://docs.borza.com/openapi/submissions/await_review_submission_v1_submissions__submission_id__await_review_post.md): Await review of a submission by updating its completion status to 'Awaiting Review'.