Projects endpoints¶
Generated from the central API contract. Availability and permissions are checked by the connected service.
GET /v1/projects¶
Projects
Authorization: projects:read Current resource access and role checks also apply.
MCP: list_projects
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
query |
No |
integer |
|
query |
No |
string |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/projects"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/projects¶
Create Project
Authorization: projects:write Current resource access and role checks also apply.
MCP: create_project
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
header |
No |
string or null |
Request body: application/json — ProjectCreate. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "idempotency-key: REPLACE_IDEMPOTENCY_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/projects"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/projects/{project_id}/documents/content¶
Store a project document (streamed body); the same content is stored once
Authorization: artifacts:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
query |
Yes |
string |
|
query |
No |
string |
|
header |
Yes |
string |
Request body: application/octet-stream — string (binary). Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "X-Content-SHA256: REPLACE_X_CONTENT_SHA256" \
"$GD_API_BASE/v1/projects/REPLACE_PROJECT_ID/documents/content?filename=REPLACE_FILENAME"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This project already holds a document with this content |
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/projects/{project_id}/documents/{artifact_id}/content¶
Read a project document’s bytes (recorded in the audit log)
Authorization: artifacts:read Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/projects/REPLACE_PROJECT_ID/documents/REPLACE_ARTIFACT_ID/content"
HTTP status |
Response schema |
|---|---|
|
JSON, JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
DELETE /v1/projects/requests/{request_id}¶
Cancel Project Creation
Authorization: projects:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X DELETE \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/projects/requests/REPLACE_REQUEST_ID"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/projects/{project_id}¶
Get Project
Authorization: projects:read Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/projects/REPLACE_PROJECT_ID"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
DELETE /v1/projects/{project_id}¶
Delete Project
Authorization: projects:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Parameter |
Location |
Required |
Type / values |
|---|---|---|---|
|
path |
Yes |
string (uuid) |
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X DELETE \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/projects/REPLACE_PROJECT_ID"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.