Docs API Reference Projects Projects Projects are containers that group together your tests, agents, schedules, and other resources. They are simple organizational buckets with no behavior of their own.
Overview A project is an organizational bucket. It groups tests, agents, schedules, and other resources together. Projects have no behavior of their own. They exist so you can scope your work in whatever way makes sense for your team: by environment (staging, production), by application, by team, or however you prefer.
Every agent must belong to a project. When you create a test or a schedule, you assign it to a project. The project's health board gives you an at-a-glance view of all tests and their current pass/fail state.
List projects
Projects are returned in descending project ID order.
Parameters Parameter Type In Required Description limitinteger query No Maximum number of projects to return. cursoruuid query No Return projects with IDs lower than this project ID.
Example Request curl "http://app.aiqaramba.com/api/v1/projects" \
-H "Authorization: Bearer $AIQA_API_KEY" Status Codes Code Description 200Projects belonging to the authenticated tenant. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 500The server could not complete the request.
Response Fields (200) Field Type Description projectsobject[] projects[].iduuid projects[].tenant_iduuid projects[].namestring projects[].descriptionstring projects[].webhook_urluri projects[].created_atdate-time projects[].updated_atdate-time next_cursoruuid
Create a project
Request Body (application/json) Field Type Required Description namestring Yes Project name descriptionstring No Project description
Example Request curl -X POST "http://app.aiqaramba.com/api/v1/projects" \
-H "Authorization: Bearer $AIQA_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "<string>"
}' Status Codes Code Description 201Project created. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 500The server could not complete the request.
Response Fields (201) Field Type Description iduuid tenant_iduuid namestring descriptionstring webhook_urluri created_atdate-time updated_atdate-time
Get a project
Parameters Parameter Type In Required Description iduuid path Yes Project ID.
Example Request curl "http://app.aiqaramba.com/api/v1/projects/<id>" \
-H "Authorization: Bearer $AIQA_API_KEY" Status Codes Code Description 200Project found. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 404The requested resource does not exist. 500The server could not complete the request.
Response Fields (200) Field Type Description iduuid tenant_iduuid namestring descriptionstring webhook_urluri created_atdate-time updated_atdate-time
Delete a project
Parameters Parameter Type In Required Description iduuid path Yes Project ID.
Example Request curl -X DELETE "http://app.aiqaramba.com/api/v1/projects/<id>" \
-H "Authorization: Bearer $AIQA_API_KEY" Status Codes Code Description 204Project deleted. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 404The requested resource does not exist. 409The request conflicts with the current resource state. 500The server could not complete the request.
Update a project
Parameters Parameter Type In Required Description iduuid path Yes Project ID.
Request Body (application/json) Field Type Required Description namestring No New project name descriptionstring No New project description
Example Request curl -X PATCH "http://app.aiqaramba.com/api/v1/projects/<id>" \
-H "Authorization: Bearer $AIQA_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "<string>",
"description": "<string>"
}' Status Codes Code Description 200Project updated. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 404The requested resource does not exist. 500The server could not complete the request.
Response Fields (200) Field Type Description iduuid tenant_iduuid namestring descriptionstring webhook_urluri created_atdate-time updated_atdate-time
Get a project webhook
The webhook signing secret is never returned.
Parameters Parameter Type In Required Description iduuid path Yes Project ID.
Example Request curl "http://app.aiqaramba.com/api/v1/projects/<id>/webhook" \
-H "Authorization: Bearer $AIQA_API_KEY" Status Codes Code Description 200Webhook configuration. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 404The requested resource does not exist. 500The server could not complete the request.
Response Fields (200) Field Type Description has_webhookboolean urluri
Configure a project webhook
Parameters Parameter Type In Required Description iduuid path Yes Project ID.
Request Body (application/json) Field Type Required Description urlstring Yes Absolute HTTPS endpoint that receives project webhook requests. secretstring No Optional HMAC signing secret
Example Request curl -X PUT "http://app.aiqaramba.com/api/v1/projects/<id>/webhook" \
-H "Authorization: Bearer $AIQA_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"url": "<string>"
}' Status Codes Code Description 204Webhook configured. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 404The requested resource does not exist. 500The server could not complete the request.
Delete a project webhook
Parameters Parameter Type In Required Description iduuid path Yes Project ID.
Example Request curl -X DELETE "http://app.aiqaramba.com/api/v1/projects/<id>/webhook" \
-H "Authorization: Bearer $AIQA_API_KEY" Status Codes Code Description 204Webhook removed. 400The request is malformed or failed validation. 401Authentication is missing or invalid. 404The requested resource does not exist. 500The server could not complete the request.