Prompts

✨ List projects compatible with prompt

Retrieve a list of compatible project for prompt.

get/api/prompts/compatible-projects

Query parameters

archivedboolean

Filter by projects that belong to archived workspaces

idsinteger[]

Multiple values may be separated by commas.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

project_type'NamedEntityRecognition' | 'TextClassification'

Skill to filter by

source_interface_idnumber
statestring
titlestring
workspacesinteger

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

Changed in 9 of the 97 revisions of this API.16114

    • added the required property results/items/collection_mode to the response with the 200 status

      response-required-property-added

    • added the new by_annotator enum value to the results/items/review_settings/sampling/allOf[ReviewSettingsSamplingEnum]/ response property for the response status 200

      response-property-enum-value-added

    • added the optional property results/items/review_settings/annotator_batch_percent to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/annotator_evaluation_metric to the response with the 200 status

      response-optional-property-added

    • added the required property results/items/internal_description to the response with the 200 status

      response-required-property-added

    • added the required property results/items/internal_description_short to the response with the 200 status

      response-required-property-added

    • the response property results/items/created_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

    • the response property results/items/prompts became nullable for the status 200

      response-property-became-nullable

    • the response property results/items/skipped_annotations_number became nullable for the status 200

      response-property-became-nullable

    • the response property results/items/workspace_title became nullable for the status 200

      response-property-became-nullable

    • the results/items/blueprints/items/task_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the results/items/is_dimensions_enabled response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • the results/items/members response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • the results/items/prompts response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • the results/items/queue_total response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the results/items/skipped_annotations_number response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the results/items/total_annotations_number response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the results/items/workspace response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • added ProjectSamplingEnum to the results/items/sampling response property allOf list for the response status 200

      response-property-all-of-added

    • removed SamplingDe5Enum from the results/items/sampling response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter archived

      new-optional-request-parameter

    • added the new optional query request parameter ids

      new-optional-request-parameter

    • added the new optional query request parameter source_interface_id

      new-optional-request-parameter

    • added the new optional query request parameter state

      new-optional-request-parameter

    • added the new optional query request parameter title

      new-optional-request-parameter

    • added the new optional query request parameter workspaces

      new-optional-request-parameter

    • the response property results/items/queue_left became nullable for the status 200

      response-property-became-nullable

    • the response property results/items/review_total_tasks became nullable for the status 200

      response-property-became-nullable

    • the response property results/items/reviewed_number became nullable for the status 200

      response-property-became-nullable

    • the response property results/items/reviewer_queue_total became nullable for the status 200

      response-property-became-nullable

    • added the optional property results/items/output_schema to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.