# YourCrowd API

## Description
This is version `v1.0.0-alpha` of this API documentation. Last update on May 24, 2023.
The YourCrowd API offers a [MTurk-compatible endpoint](https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/Welcome.html) at `https://yourcrowd.ai.moda/api/aws-compatible`.<br><br>

```python
# Replace the following with your own credentials
yourcrowd_account_email='openapi@yourcrowd.testing.email.ai.moda'
yourcrowd_api_key = 'eyJhbGciOiJFUzI1NiJ9.eyJlbWFpbCI6ImRhdmlkLm1hbm91Y2hlaHJpQGFpLm1vZGEiLCJleHAiOjE3MTYyNjg4NjIsImlhdCI6MTY4NDczMjg2MiwiaXNzIjoiYXBpLnlvdXJjcm93ZC5haS5tb2RhIiwic3ViIjoiMTkzZWVkNjQtMWI2YS00NWEzLTkyN2MtZWQzY2Y5MjBlODI3In0.JRu-ZaMNizw77YtbupbBSWYitryQwbJ27fey4vJTdXlqTtKFMcDQX_jzm99LcbGf-9juRv4-4ZexPPu4_KXuPw'

yourcrowd_endpoint = 'https://yourcrowd.ai.moda/api/aws-compatible'
sts = boto3.client('sts', endpoint_url=yourcrowd_endpoint, aws_secret_access_key='sts', aws_access_key_id=yourcrowd_account_email)

credentials = sts.get_session_token(SerialNumber='anything_here', TokenCode=yourcrowd_api_key)

mturk = boto3.client('mturk', endpoint_url=yourcrowd_endpoint, aws_secret_access_key=credentials['Credentials']['SecretAccessKey'], aws_access_key_id=credentials['Credentials']['AccessKeyId'], aws_session_token=credentials['Credentials']['SessionToken'])

# You can now use this client as normal, no code changes required!
response = mturk.get_account_balance()
```

## Servers

## Authentication
The API accepts 2 different authentication methods:
- Cookie auth (http_api_key)
- Bearer auth (http)




## Endpoints and operations

### [Tasking](https://yourcrowd.bump.ai.moda/group/endpoint-tasking.md)
- [Accept Qualification Request](https://yourcrowd.bump.ai.moda/operation/operation-put-v1-accept-qualification-request.md)
- [Approve Assignment](https://yourcrowd.bump.ai.moda/operation/operation-put-v1-approve-assignment.md)
- [Associate Qualification With Worker](https://yourcrowd.bump.ai.moda/operation/operation-put-v1-associate-qualification-with-worker.md)
- [Create Additional Assignments For HIT](https://yourcrowd.bump.ai.moda/operation/operation-post-v1-create-additional-assignments-for-hit.md)
- [Get Account Balance](https://yourcrowd.bump.ai.moda/operation/operation-get-v1-get-account-balance.md)
- [Create HIT](https://yourcrowd.bump.ai.moda/operation/operation-post-v1-create-hit.md)
- [Get HIT](https://yourcrowd.bump.ai.moda/operation/operation-get-v1-get-hit.md)
- [List Assignments For HIT](https://yourcrowd.bump.ai.moda/operation/operation-get-v1-list-assignments-for-hit.md)
- [List HITs](https://yourcrowd.bump.ai.moda/operation/operation-get-v1-list-hits.md)
- [Create HIT Type](https://yourcrowd.bump.ai.moda/operation/operation-post-v1-create-hit-type.md)
- [Create HIT with HIT type](https://yourcrowd.bump.ai.moda/operation/operation-post-v1-create-hit-with-hit-type.md)
- [Create qualification type](https://yourcrowd.bump.ai.moda/operation/operation-post-v1-create-qualification-type.md)
- [Create worker block](https://yourcrowd.bump.ai.moda/operation/operation-post-v1-create-worker-block.md)
- [Delete HIT](https://yourcrowd.bump.ai.moda/operation/operation-delete-v1-delete-hit.md)
- [Delete Qualification Type](https://yourcrowd.bump.ai.moda/operation/operation-delete-v1-delete-qualification-type.md)
- [Delete Worker Block](https://yourcrowd.bump.ai.moda/operation/operation-delete-v1-delete-worker-block.md)
- [Disassociate Qualification From Worker](https://yourcrowd.bump.ai.moda/operation/operation-delete-v1-disassociate-qualification-from-worker.md)
- [Get Assignment](https://yourcrowd.bump.ai.moda/operation/operation-get-v1-get-assignment.md)
- [Get File Upload URL](https://yourcrowd.bump.ai.moda/operation/operation-get-v1-get-file-upload-url.md)
### [Auth](https://yourcrowd.bump.ai.moda/group/endpoint-auth.md)
- [Generate API Key](https://yourcrowd.bump.ai.moda/operation/operation-post-v2-auth-generate-api-key.md)



[Powered by Bump.sh](https://bump.sh)