CopyHero
Back to CopyHero

Read Blueprint

GET
/api/v1/blueprints/tasks/{id}

Get a specific TaskBlueprint by ID

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

id*Id

Query Parameters

include_deleted?Include Deleted
Defaultfalse

Response Body

Successful Response

application/json
  1. response
name*Name
description?string|null
owner_id?integer|null
id*Id
jobs*array<>
created_at*Created At
Formatdate-time
updated_at*Updated At
Formatdate-time
Example Request
curl -X GET 'https://app.copyhero.app/api/v1/blueprints/tasks/0'
Example Response
{  "name": "string",  "description": "string",  "owner_id": 0,  "id": 0,  "jobs": [    {      "name": "string",      "description": "string",      "job_type": "string",      "input_data": "string",      "id": 0,      "owner_id": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Read Blueprint Jobs GET

List TaskBlueprintJobs with usage statistics, filtering, searching, and sorting. Returns a ``{data, count}`` envelope where ``count`` is the total number of rows matching the filters (ignoring pagination). List rows are the slim ``TaskBlueprintJobListItem`` (no ``input_data``); the full blob lives on the detail endpoint ``GET /blueprints/jobs/{id}``. Filters: - search_query: Search in name and description (ILIKE) - job_type: Filter by job type (e.g., 'translate', 'import') - owner_id: Filter by owner ID (superuser only) - owned_only: Only the caller's own jobs (no global rows) - created_by_user_id: Filter by creator user ID (superuser only) - sort_by: Sort by id, created_at, updated_at, name, or job_type - sort_order: Sort direction (asc or desc) - skip: Number of records to skip for pagination - limit: Maximum number of records to return

Read Blueprints GET

List TaskBlueprints with filtering, searching, and sorting. Filters: - search_query: Search in name and description (ILIKE) - owner_id: Filter by owner ID (superuser only) - owner_user_id: Filter by the owning user's organizations (superuser only) - owned_only: Restrict to the current user's own blueprints (excludes global and other users' rows) - must_include_job_type: Restrict to blueprints whose jobs include this type - sort_by: Sort by created_at, updated_at, or name - sort_order: Sort direction (asc or desc) - skip: Number of records to skip for pagination - limit: Maximum number of records to return