{ "opencollection": "1.0.0", "info": { "name": "proto/clarifai/api/service.proto V2 API", "version": "version not set" }, "items": [ { "info": { "name": "V2", "type": "folder" }, "items": [ { "info": { "name": "List all the annotation filters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/annotation_filters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the annotation filters." }, { "info": { "name": "Add annotation filters.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/annotation_filters" }, "docs": "Add annotation filters." }, { "info": { "name": "Patch one or more annotation filters.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/annotation_filters" }, "docs": "Patch one or more annotation filters." }, { "info": { "name": "Delete one or more annotation filters in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/annotation_filters" }, "docs": "Delete one or more annotation filters in a single request." }, { "info": { "name": "Get a specific annotation filter.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/annotation_filters/:annotation_filter_id", "params": [ { "name": "annotation_filter_id", "value": "", "type": "path", "description": "Identify annotation filter by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific annotation filter." }, { "info": { "name": "List all the annotation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/annotations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query", "description": "List annotations for these IDs" }, { "name": "input_ids", "value": "", "type": "query", "description": "List annotations for these Input IDs\nNote that 'ids' are optional but if the are provided the number and order in\n'ids' and 'input_ids' should match\nIf you do not specify 'ids' all the annotations for 'input_ids' are returned\nIf a you do not specify both 'input_ids' and 'ids' all the annotations in the app are returned" }, { "name": "user_ids", "value": "", "type": "query", "description": "Only return the annotations that has one of these user IDs, effectively operating as an\nOR among them to filter down the results.\nIf model_version_ids or workflow_version_ids are also provided, these user_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request.\nSetting user_ids does also set list_all_annotations=True." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Only return the annotations that has one of these model version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or workflow_version_ids are also provided, these model_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request.\nSetting model_version_ids does also set list_all_annotations=True." }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "Only return the annotations that has one of these workflow version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or model_version_ids are also provided, these workflow_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request.\nSetting workflow_version_ids does also set list_all_annotations=True." }, { "name": "list_all_annotations", "value": "", "type": "query", "description": "Set this flag to list both trusted and not trusted annotations\nby default it's listing only trusted annotations" }, { "name": "return_model_output", "value": "", "type": "query", "description": "Set this flag to return the model output for model annotations in the response." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "task_id", "value": "", "type": "query", "description": "Flag to filter annotations by task_id" } ] }, "docs": "List all the annotation." }, { "info": { "name": "Post annotations.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/annotations" }, "docs": "Post annotations." }, { "info": { "name": "Patch one or more annotations.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/annotations" }, "docs": "Patch one or more annotations." }, { "info": { "name": "Delete multiple annotations in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/annotations" }, "docs": "Delete multiple annotations in one request." }, { "info": { "name": "Execute a search over annotations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/annotations/searches" }, "docs": "Execute a search over annotations" }, { "info": { "name": "Patch saved annotations searches by ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/annotations/searches" }, "docs": "Patch saved annotations searches by ids." }, { "info": { "name": "ListAnnotationWorkers lists users, models, and workflows (collectively\nknown as \"workers\") that have added annotations to the application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/annotations/workers", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response.\nCurrently supported: all, names" }, { "name": "trusted_only", "value": "", "type": "query", "description": "(optional URL parameter) Only list workers that have created trusted annotations." } ] }, "docs": "ListAnnotationWorkers lists users, models, and workflows (collectively\nknown as \"workers\") that have added annotations to the application." }, { "info": { "name": "Get a specific app from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/app", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, counts" } ] }, "docs": "Get a specific app from an app." }, { "info": { "name": "List all the apps.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/apps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, counts" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_name", "value": "", "type": "query", "description": "Whether to order by the name." }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the app" }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the id" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "featured_only", "value": "", "type": "query", "description": "Filtering options:\nIf true, we only return apps that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return apps that are starred by the requesting user" }, { "name": "template_only", "value": "", "type": "query", "description": "If true, we only return apps that are marked as a template by the app owner." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the application:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query various text fields (id, name, description, and notes) that can contain the words in the query string\nDeprecated: use search instead." }, { "name": "name", "value": "", "type": "query", "description": "Filter by the id, name and notes of the app. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "id", "value": "", "type": "query", "description": "Filter by the user-unique-id of the app. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." } ] }, "docs": "List all the apps." }, { "info": { "name": "This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload.\nThe config must be sent first before the artifact_bytes can be uploaded.\nOnce the config has been sent, the server will respond with a confirmation containing the artifact_version_id.\nThis is so that if your upload is interrupted, you can resume the upload by sending the config again with the artifact_version_id specified for your artifact_version.\nThe actual upload will be done via a multipart upload, the latest successful part_id will be sent from the server in the response to the artifact_bytes.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/artifact_versions/upload" }, "docs": "This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload.\nThe config must be sent first before the artifact_bytes can be uploaded.\nOnce the config has been sent, the server will respond with a confirmation containing the artifact_version_id.\nThis is so that if your upload is interrupted, you can resume the upload by sending the config again with the artifact_version_id specified for your artifact_version.\nThe a" }, { "info": { "name": "List all the bulk operations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/bulk_operations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the bulk operations" }, { "info": { "name": "Perform bulk operations on a list of inputs based on input source.\nOperation include add, update, delete of concepts, metadata and geo data.\nThis is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/bulk_operations" }, "docs": "Perform bulk operations on a list of inputs based on input source.\nOperation include add, update, delete of concepts, metadata and geo data.\nThis is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status." }, { "info": { "name": "Cancel one or more bulk operations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/bulk_operations" }, "docs": "Cancel one or more bulk operations" }, { "info": { "name": "delete one or more terminated bulk operations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/bulk_operations" }, "docs": "delete one or more terminated bulk operations" }, { "info": { "name": "Get the bulk operation details by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/bulk_operations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The bulk operation id" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get the bulk operation details by ID" }, { "info": { "name": "List Available Cloud Providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cloud_providers" }, "docs": "List Available Cloud Providers" }, { "info": { "name": "List Regions for given Cloud Provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cloud_providers/:cloud_provider.id/regions", "params": [ { "name": "cloud_provider.id", "value": "", "type": "path", "description": "Unique identifier of the cloud provider." }, { "name": "cloud_provider.name", "value": "", "type": "query", "description": "Name of the cloud provider." } ] }, "docs": "List Regions for given Cloud Provider" }, { "info": { "name": "Get InstanceTypes given Cloud Provider and Region", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cloud_providers/:cloud_provider.id/regions/:region/instance_types", "params": [ { "name": "cloud_provider.id", "value": "", "type": "path", "description": "Unique identifier of the cloud provider." }, { "name": "region", "value": "", "type": "path", "description": "The region to list for so when there are multiple regions we get only the clusters\nthat are supposed to be up in that region." }, { "name": "cloud_provider.name", "value": "", "type": "query", "description": "Name of the cloud provider." } ] }, "docs": "Get InstanceTypes given Cloud Provider and Region" }, { "info": { "name": "V2_ListComputeClusters2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/compute_clusters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostComputePlaneMetrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/compute_plane_metrics" } }, { "info": { "name": "List all the concepts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/concepts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "id", "value": "", "type": "query", "description": "Fuzzy match on concept ID" } ] }, "docs": "List all the concepts." }, { "info": { "name": "Add a concept to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/concepts" }, "docs": "Add a concept to an app." }, { "info": { "name": "Patch one or more concepts.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/concepts" }, "docs": "Patch one or more concepts." }, { "info": { "name": "List all domain graphs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/concepts/knowledge_graphs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "List all domain graphs." }, { "info": { "name": "Post domain graphs.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/concepts/knowledge_graphs" }, "docs": "Post domain graphs." }, { "info": { "name": "Search over the concepts to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/concepts/searches" }, "docs": "Search over the concepts to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request." }, { "info": { "name": "List all the concepts with their positive and negative counts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/concepts/status", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the concepts with their positive and negative counts" }, { "info": { "name": "Get a specific concept from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/concepts/:concept_id", "params": [ { "name": "concept_id", "value": "", "type": "path", "description": "The concept's id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific concept from an app." }, { "info": { "name": "List the concept in all the translated languages.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/concepts/:concept_id/languages", "params": [ { "name": "concept_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List the concept in all the translated languages." }, { "info": { "name": "Add a new translation for this concept.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/concepts/:concept_id/languages", "params": [ { "name": "concept_id", "value": "", "type": "path" } ] }, "docs": "Add a new translation for this concept." }, { "info": { "name": "Patch the name for a given language names by passing in a list of concepts with the new names\nfor the languages.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/concepts/:concept_id/languages", "params": [ { "name": "concept_id", "value": "", "type": "path" } ] }, "docs": "Patch the name for a given language names by passing in a list of concepts with the new names\nfor the languages." }, { "info": { "name": "Get a specific concept from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/concepts/:concept_id/languages/:language", "params": [ { "name": "concept_id", "value": "", "type": "path" }, { "name": "language", "value": "", "type": "path", "description": "This is the language identifier." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific concept from an app." }, { "info": { "name": "List all the datasets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the app" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "If neither sort option is set to true, will sort by modified_at." }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the external id" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "starred_only", "value": "", "type": "query", "description": "Filtering options:" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter datasets by bookmark. If set, only return bookmarked datasets. Otherwise none bookmarked datasets only." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the dataset:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "id", "value": "", "type": "query", "description": "Fuzzy filter on dataset ID\nDeprecated: use search instead." } ] }, "docs": "List all the datasets." }, { "info": { "name": "Add datasets to an app.\nThe process is atomic, i.e. either all or no datasets are added.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/datasets" }, "docs": "Add datasets to an app.\nThe process is atomic, i.e. either all or no datasets are added.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error." }, { "info": { "name": "Patch one or more datasets.\nThe process is atomic, i.e. either all or no datasets are patched.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/datasets" }, "docs": "Patch one or more datasets.\nThe process is atomic, i.e. either all or no datasets are patched.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error." }, { "info": { "name": "Delete one or more datasets in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/datasets" }, "docs": "Delete one or more datasets in a single request." }, { "info": { "name": "Get a specific dataset.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query" } ] }, "docs": "Get a specific dataset." }, { "info": { "name": "List all the dataset inputs in a dataset.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets/:dataset_id/inputs", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the dataset inputs in a dataset." }, { "info": { "name": "Add dataset inputs to a dataset.\nThe process is not atomic, i.e. if there are errors with some dataset\ninputs, others might still be added. The response reports\n - SUCCESS if all dataset inputs were added,\n - MIXED_STATUS if only some dataset inputs were added, and\n - FAILURE if no dataset inputs were added.\nEach individual dataset input in the response has the status set to\nindicate if it was successful or if there was an error.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/datasets/:dataset_id/inputs", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Add dataset inputs to a dataset.\nThe process is not atomic, i.e. if there are errors with some dataset\ninputs, others might still be added. The response reports\n - SUCCESS if all dataset inputs were added,\n - MIXED_STATUS if only some dataset inputs were added, and\n - FAILURE if no dataset inputs were added.\nEach individual dataset input in the response has the status set to\nindicate if it was successful or if there was an error." }, { "info": { "name": "Delete one or more dataset inputs in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/datasets/:dataset_id/inputs", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Delete one or more dataset inputs in a single request." }, { "info": { "name": "Get a specific dataset input.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets/:dataset_id/inputs/:input_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "input_id", "value": "", "type": "path", "description": "Identify dataset input by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific dataset input." }, { "info": { "name": "List all the dataset versions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "request_origins", "value": "", "type": "query", "description": "(optional URL parameter) Filter by origin of dataset version" } ] }, "docs": "List all the dataset versions." }, { "info": { "name": "Add dataset versions to a dataset.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Add dataset versions to a dataset." }, { "info": { "name": "Patch one or more dataset versions.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Patch one or more dataset versions." }, { "info": { "name": "Delete one or more dataset versions in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Delete one or more dataset versions in a single request." }, { "info": { "name": "Get a specific dataset version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions/:dataset_version_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "dataset_version_id", "value": "", "type": "path", "description": "Identify dataset version by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific dataset version." }, { "info": { "name": "Create export of a dataset version.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions/:dataset_version_id/exports", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "dataset_version_id", "value": "", "type": "path", "description": "Identify dataset version by id." } ] }, "docs": "Create export of a dataset version." }, { "info": { "name": "V2_ListDatasetVersionMetricsGroups2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/datasets/:dataset_id/versions/:dataset_version_id/metrics", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "dataset_version_id", "value": "", "type": "path", "description": "Identify dataset version by id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "parent_paths", "value": "", "type": "query", "description": "Filter by parent path. Multiple parent paths are OR-ed. Empty list results in no filter." }, { "name": "types", "value": "", "type": "query", "description": "Filter by parent type. Multiple types are OR-ed. Empty list results in no filter.\n\n - INPUT_TYPE: Group data examples by input type.\nExamples: images, videos, text, audio.\n - CONCEPT_ID: Group data examples by concept ID.\nExamples: inputs with cat concept, inputs with dog concept.\n - CONCEPTS_COUNT: Group data examples by concepts count.\nExamples: inputs with 20 concepts, inputs with 21 concepts.\n - BOUNDING_BOXES_COUNT: Group data examples by bounding boxes count.\nExamples: inputs with 20 bounding boxes, inputs with 21 bounding boxes.\n - POLYGONS_COUNT: Group data examples by polygons count.\nExamples: inputs with 20 polygons, inputs with 21 polygons.\n - POINTS_COUNT: Group data examples by points count.\nExamples: inputs with 20 points, inputs with 21 points.\n - MASKS_COUNT: Group data examples by masks count.\nExamples: inputs with 20 masks, inputs with 21 masks.\n - PIXELS_COUNT: Group data examples by pixels count.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 400: inputs with [200000, 200400) pixels, inputs with [200400, 200800) pixels.\n - ASPECT_RATIO: Group data examples by aspect ratio.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 0.1: inputs with [0.5, 0.6) aspect ratio, inputs with [0.6, 0.7) aspect ratio." } ] } }, { "info": { "name": "V2_ListDeployments2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/deployments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query", "description": "(optional URL parameter) Nodepool ID. To list all deployed workers in a Nodepool" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "(optional URL parameter) ModelVersion IDs. To list all deployments for the model version" }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "(optional URL parameter) WorkflowVersion IDs. To list all deployments for the workflow version" }, { "name": "compute_cluster_id", "value": "", "type": "query", "description": "(optional URL parameter) ComputeCluster ID. To list all deployed workers in a ComputeCluster" }, { "name": "scheduling_priorities", "value": "", "type": "query", "description": "(optional URL parameter) Scheduling priorities. To list all deployments with one of the\nprovided scheduling priorities. Valid values are 0-9." } ] } }, { "info": { "name": "V2_ListEvaluations3", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "If true, sort in ascending order, otherwise sort in descending order." }, { "name": "sort_by_app_id", "value": "", "type": "query", "description": "Whether to order by application id" }, { "name": "sort_by_roc_auc", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_roc_auc" }, { "name": "sort_by_f1", "value": "", "type": "query", "description": "Whether to order by eval metric summary.f1" }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by when the metric was created" }, { "name": "sort_by_mean_avg_precision", "value": "", "type": "query", "description": "Whether to order by eval metric summary.mean_avg_precision_iou_50" }, { "name": "sort_by_precision", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_precision" }, { "name": "sort_by_recall", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_recall" }, { "name": "sort_by_model_id", "value": "", "type": "query" }, { "name": "sort_by_eval_dataset_id", "value": "", "type": "query" }, { "name": "sort_by_train_dataset_id", "value": "", "type": "query" }, { "name": "model_type_id", "value": "", "type": "query", "description": "Filter on model type id" }, { "name": "eval_dataset_ids", "value": "", "type": "query", "description": "Filter on dataset ID of the dataset version specified in the metric version" }, { "name": "train_dataset_ids", "value": "", "type": "query", "description": "Filter on dataset ID of the dataset version specified by the model version" }, { "name": "concept_ids", "value": "", "type": "query", "description": "Filter on concept IDs specified in the modele version's output_info" }, { "name": "show_failed_metrics", "value": "", "type": "query", "description": "Whether to show failed metrics, defaults to false" } ] } }, { "info": { "name": "V2_PostEvaluations2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/evaluations" } }, { "info": { "name": "V2_GetEvaluation2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/evaluations/:evaluation_id", "params": [ { "name": "evaluation_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "fields.confusion_matrix", "value": "", "type": "query" }, { "name": "fields.cooccurrence_matrix", "value": "", "type": "query" }, { "name": "fields.label_counts", "value": "", "type": "query" }, { "name": "fields.binary_metrics", "value": "", "type": "query" }, { "name": "fields.test_set", "value": "", "type": "query" }, { "name": "fields.metrics_by_area", "value": "", "type": "query" }, { "name": "fields.metrics_by_class", "value": "", "type": "query" } ] } }, { "info": { "name": "List all the inputs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "status.code", "value": "", "type": "query", "description": "Status code from internal codes.\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" }, { "name": "status.description", "value": "", "type": "query", "description": "A short description of the error." }, { "name": "status.details", "value": "", "type": "query", "description": "More details of the given error.\nThese details may be exposed to non-technical users.\nFor technical details, try to use developer_notes field." }, { "name": "status.stack_trace", "value": "", "type": "query", "description": "For some environment we may return a stack trace to help debug\nany issues." }, { "name": "status.percent_completed", "value": "", "type": "query", "description": "specifically for long running jobs" }, { "name": "status.time_remaining", "value": "", "type": "query", "description": "if status is pending, how much time is remaining (in seconds)" }, { "name": "status.req_id", "value": "", "type": "query", "description": "A request ID may be present, to help monitoring and tracking requests" }, { "name": "status.internal_details", "value": "", "type": "query", "description": "Internal Annotation (do not set in production, for internal Clarifai use only)." }, { "name": "status.redirect_info.url", "value": "", "type": "query", "description": "New location for the resource. Used to set response Location header." }, { "name": "status.redirect_info.resource_type", "value": "", "type": "query", "description": "Resource type" }, { "name": "status.redirect_info.old_resource_id", "value": "", "type": "query", "description": "Old resource id" }, { "name": "status.redirect_info.new_resource_id", "value": "", "type": "query", "description": "New resource id" }, { "name": "status.developer_notes", "value": "", "type": "query", "description": "Notes for developer.\nThese notes are rather technical details for developers how to interpret the status,\ne.g. why an error occurred and how to avoid getting the error." }, { "name": "status.http_status_code", "value": "", "type": "query", "description": "The HTTP status code of the response." }, { "name": "ids", "value": "", "type": "query" } ] }, "docs": "List all the inputs." }, { "info": { "name": "PostInputs adds one or more inputs to the app.\nTakes a list of image/video/audio/text URLs, image/video/audio bytes or raw text\nOptionally, include concepts or dataset ids to link them\nOptionally, include metadata for search\nNote that inputs processing is asynchronous process\nSee ListInputs, StreamInputs or PostInputSearches to list results", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs" }, "docs": "PostInputs adds one or more inputs to the app.\nTakes a list of image/video/audio/text URLs, image/video/audio bytes or raw text\nOptionally, include concepts or dataset ids to link them\nOptionally, include metadata for search\nNote that inputs processing is asynchronous process\nSee ListInputs, StreamInputs or PostInputSearches to list results" }, { "info": { "name": "Patch one or more inputs.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/inputs" }, "docs": "Patch one or more inputs." }, { "info": { "name": "Delete multiple inputs in one request.\nThis call is asynchronous.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/inputs" }, "docs": "Delete multiple inputs in one request.\nThis call is asynchronous." }, { "info": { "name": "Delete multiple annotations in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/inputs/annotations" }, "docs": "Delete multiple annotations in one request." }, { "info": { "name": "Initiates retrieval of inputs from cloud storage from a user provided data source.\nWill create and return an inputs-add-job for tracking progress.\nArchives will be extracted and their contents will be processed as inputs.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/data_sources" }, "docs": "The cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process\nfiles in the images_folder beginning with abc or in a subfolder beginning with abc.\nFor example:\nbucket/images_folder/abcImage.png\nbucket/images_folder/abc-1/Data.zip\n\nIf given URL is for a private bucket or file, then credentials should be provided to access the bucket.\nCredentials should include rights to list the objects in the bucket, except when pointed directly at a file archive,\nin whic" }, { "info": { "name": "List all the inputs add jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/jobs/add", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the inputs add jobs" }, { "info": { "name": "Get the input add job details by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/jobs/add/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of add inputs job" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get the input add job details by ID" }, { "info": { "name": "cancel the input add job by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/inputs/jobs/add/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of add inputs job to be cancelled" } ] }, "docs": "cancel the input add job by ID" }, { "info": { "name": "List all the input extraction jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/jobs/extraction", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the input extraction jobs" }, { "info": { "name": "V2_CancelInputsExtractionJobs2", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/inputs/jobs/extraction" } }, { "info": { "name": "Get the input extraction job details by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/jobs/extraction/:inputs_extraction_job_id", "params": [ { "name": "inputs_extraction_job_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get the input extraction job details by ID" }, { "info": { "name": "Execute a search over inputs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/searches" }, "docs": "Execute a search over inputs" }, { "info": { "name": "Patch saved inputs searches by ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/inputs/searches" }, "docs": "Patch saved inputs searches by ids." }, { "info": { "name": "Get input count per status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/status", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get input count per status." }, { "info": { "name": "Streams all the inputs starting from oldest assets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/stream", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 20." }, { "name": "last_id", "value": "", "type": "query" }, { "name": "order_by_id", "value": "", "type": "query", "description": "By default, the endpoint return inputs by the time when it is added.\nIf this is set to true, we will return inputs by id." }, { "name": "descending", "value": "", "type": "query" } ] }, "docs": "Streams all the inputs starting from oldest assets." }, { "info": { "name": "Create new upload job with a file archive containing inputs (images, videos, text, audio)\nActual file upload happens in next steps by calling `PutUploadContentParts` endpoint\nand providing the file content in the request body.\nThis endpoint creates and return an inputs-add-job which contains an upload id needed for upload and further status tracking\nCompleting the upload will automatically begin unpacking the archive and uploading the contents as inputs.\nSee also GetInputsAddJob and then GetInputsExtractionJob", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/uploads" }, "docs": "Create new upload job with a file archive containing inputs (images, videos, text, audio)\nActual file upload happens in next steps by calling `PutUploadContentParts` endpoint\nand providing the file content in the request body.\nThis endpoint creates and return an inputs-add-job which contains an upload id needed for upload and further status tracking\nCompleting the upload will automatically begin unpacking the archive and uploading the contents as inputs.\nSee also GetInputsAddJob and then GetInpu" }, { "info": { "name": "Get a specific input from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/:input_id", "params": [ { "name": "input_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific input from an app." }, { "info": { "name": "Delete a single input asynchronously.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/inputs/:input_id", "params": [ { "name": "input_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Delete a single input asynchronously." }, { "info": { "name": "List all the annotation tracks.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/:input_id/annotation_tracks", "params": [ { "name": "input_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "List all the annotation tracks." }, { "info": { "name": "Post annotation tracks.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/:input_id/annotation_tracks", "params": [ { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Post annotation tracks." }, { "info": { "name": "Patch one or more annotation tracks.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/inputs/:input_id/annotation_tracks", "params": [ { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more annotation tracks." }, { "info": { "name": "Delete multiple annotation tracks in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/inputs/:input_id/annotation_tracks", "params": [ { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple annotation tracks in one request." }, { "info": { "name": "Stream live video annotations as soon as they are available.\nThis endpoint will NOT replay old annotations, but only stream new annotations that are generated after the stream is opened.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/:input_id/annotations/stream/live", "params": [ { "name": "input_id", "value": "", "type": "path", "description": "The input ID containing the video being processed" } ] }, "docs": "Stream live video annotations as soon as they are available.\nThis endpoint will NOT replay old annotations, but only stream new annotations that are generated after the stream is opened." }, { "info": { "name": "Get a specific annotation from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/:input_id/annotations/:annotation_id", "params": [ { "name": "input_id", "value": "", "type": "path" }, { "name": "annotation_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific annotation from an app." }, { "info": { "name": "Delete a single annotation.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/inputs/:input_id/annotations/:annotation_id", "params": [ { "name": "input_id", "value": "", "type": "path" }, { "name": "annotation_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Delete a single annotation." }, { "info": { "name": "List video track annotations for a specific input.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/:input_id/track_annotations/searches", "params": [ { "name": "input_id", "value": "", "type": "path", "description": "The input ID containing the video track annotations to list" } ] }, "docs": "List video track annotations for a specific input." }, { "info": { "name": "Stream annotations for a specific input one-by-one.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/inputs/:input_id/track_annotations/searches/stream", "params": [ { "name": "input_id", "value": "", "type": "path", "description": "The input ID containing the annotations to stream" } ] }, "docs": "Stream annotations for a specific input one-by-one." }, { "info": { "name": "Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs and successfully processed\nExperimental. Manifest is used by browser and desktop clients that implement an efficient streaming playback\nThis means client can switch between low-resolution and high-resolution video streams\nDepending on network bandwidth or user's preference\nThis also means that reencoded video streams are reencoded in a uniform way, not relying on original format\nAlternative to MPEG-dash is to stream original file with byte-range header", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/inputs/:input_id/video_manifest", "params": [ { "name": "input_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs and successfully processed\nExperimental. Manifest is used by browser and desktop clients that implement an efficient streaming playback\nThis means client can switch between low-resolution and high-resolution video streams\nDepending on network bandwidth or user's preference\nThis also means that reencoded video streams are reencoded in a uniform way, not relying on original format\nAlternative to MPEG-dash is to stream or" }, { "info": { "name": "List label orders.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/label_orders", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List label orders." }, { "info": { "name": "Add Label orders.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/label_orders" }, "docs": "Add Label orders." }, { "info": { "name": "Patch one or more label orders.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/label_orders" }, "docs": "Patch one or more label orders." }, { "info": { "name": "Delete multiple label orders in one request.\nthis do not change task status", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/label_orders" }, "docs": "Delete multiple label orders in one request.\nthis do not change task status" }, { "info": { "name": "Get a label order.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/label_orders/:label_order_id", "params": [ { "name": "label_order_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a label order." }, { "info": { "name": "V2_PostLogEntries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/log_entries" } }, { "info": { "name": "List all the models.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets, counts" }, { "name": "show_replicas", "value": "", "type": "query", "description": "If true, show replica counts for models." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_name", "value": "", "type": "query", "description": "Whether to order by the name" }, { "name": "sort_by_num_inputs", "value": "", "type": "query", "description": "Whether to order by the number of training inputs" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time of the latest model version.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at" }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by count of stars" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "model_type_id", "value": "", "type": "query", "description": "Filtering options:\nFilter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id's\nsupported." }, { "name": "trained_only", "value": "", "type": "query", "description": "If true, we only return models that have the status MODEL_TRAINED, which includes non-trainable model types." }, { "name": "input_fields", "value": "", "type": "query", "description": "The list of input fields to the model.\nFor example, you can specify 'image', which will return models that make inferences on images like visual-classifier models." }, { "name": "output_fields", "value": "", "type": "query", "description": "The list of output fields to the model.\nFor example, you can specify 'regions[...].data.concepts', which will return visual-detector models." }, { "name": "license", "value": "", "type": "query", "description": "Filter by the license of the model version" }, { "name": "featured_only", "value": "", "type": "query", "description": "If true, we only return models that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return models that are starred by the requesting user" }, { "name": "toolkits", "value": "", "type": "query", "description": "List of toolkit tags to filter by" }, { "name": "use_cases", "value": "", "type": "query", "description": "List of use_case tags to filter by" }, { "name": "languages", "value": "", "type": "query", "description": "List of language tags to filter by" }, { "name": "dont_fetch_from_main", "value": "", "type": "query", "description": "Old API behavior resulted in returning clarifai main models when calling ListModels while scoped to an app. While we transition\naway from that, we can use this flag to not always fetch clarifai main models, unless that is the app we are explicitly listing for.\n\n@exclude TODO (EAGLE-4447): Remove this field" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter models by bookmark. If set, only return bookmarked models. Otherwise none bookmarked models only.\nNote: you can not filter `trained_only` and bookmark at the same time.\nWhen filter by bookmark, we will return trained and untrained models." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Filter by the model version ids. If set, only return the model of these versions." }, { "name": "license_type", "value": "", "type": "query", "description": "Filter by LicenseType" }, { "name": "source", "value": "", "type": "query", "description": "Filter by Source" }, { "name": "creator", "value": "", "type": "query", "description": "Filter by Creator" }, { "name": "min_replicas", "value": "", "type": "query", "description": "Filter by model versions runners with replicas >= min_replicas." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the model:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query name, description and id fields, that can contain the words in the query string. Does NOT support wildcards - full words only. Supports operators \"OR\" and \"-\" as NOT.\nDeprecated: use search instead." }, { "name": "name", "value": "", "type": "query", "description": "Filter by the description and id of the model. This supports wildcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "filter_by_user_id", "value": "", "type": "query", "description": "Extends the name filter to include the user_id of the application owner that the model belongs to.\nDeprecated: use search instead of name." } ] }, "docs": "List all the models." }, { "info": { "name": "Add a models to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models" }, "docs": "Add a models to an app." }, { "info": { "name": "Patch one or more models.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/models" }, "docs": "Patch one or more models." }, { "info": { "name": "Delete multiple models in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/models" }, "docs": "Delete multiple models in one request." }, { "info": { "name": "Stream of requests and stream of responses", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/outputs/stream" }, "docs": "Stream of requests and stream of responses" }, { "info": { "name": "Search over the models to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/searches" }, "docs": "Search over the models to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request." }, { "info": { "name": "List all the model types available in the platform.\nThis MUST be above ListModels so that the /models/types endpoint takes precedence.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/types", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the model types available in the platform.\nThis MUST be above ListModels so that the /models/types endpoint takes precedence." }, { "info": { "name": "Get a specific model type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/types/:model_type_id", "params": [ { "name": "model_type_id", "value": "", "type": "path", "description": "The specific ModelType.Id you want to retrieve." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific model type." }, { "info": { "name": "This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload.\nThe config must be sent first before the model_bytes can be uploaded.\nOnce the config has been sent, the server will respond with a confirmation containing the model_version_id.\nThis is so that if your upload is interrupted, you can resume the upload by sending the config again with the model_version_id specified for your model_version.\nThe actual upload will be done via a multipart upload, the latest successful part_id will be sent from the server in the response to the model_bytes.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/versions/upload" }, "docs": "This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload.\nThe config must be sent first before the model_bytes can be uploaded.\nOnce the config has been sent, the server will respond with a confirmation containing the model_version_id.\nThis is so that if your upload is interrupted, you can resume the upload by sending the config again with the model_version_id specified for your model_version.\nThe actual upload" }, { "info": { "name": "Get a specific model from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "version_id", "value": "", "type": "query", "description": "This is included so that we can re-use this request for multiple\nrpcs with and without the version_id." }, { "name": "language", "value": "", "type": "query" }, { "name": "trained_before", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets" } ] }, "docs": "Get a specific model from an app." }, { "info": { "name": "Delete a single model.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/models/:model_id", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Delete a single model." }, { "info": { "name": "Update model check consents", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/models/:model_id/check_consents", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "the model id" } ] }, "docs": "Update model check consents" }, { "info": { "name": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/inputs", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "version_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Update model languages tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/models/:model_id/languages", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Update model languages tags" }, { "info": { "name": "Get a the output info for a given model_id or model_id/version_id\ncombo.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/output_info", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "version_id", "value": "", "type": "query", "description": "This is included so that we can re-use this request for multiple\nrpcs with and without the version_id." }, { "name": "language", "value": "", "type": "query" }, { "name": "trained_before", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets" } ] }, "docs": "Get a the output info for a given model_id or model_id/version_id\ncombo." }, { "info": { "name": "Get predicted outputs from the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/outputs", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Get predicted outputs from the model." }, { "info": { "name": "PostModelVersionsPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/publish", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "PostModelVersionsPublish" }, { "info": { "name": "Lists model references tied to a particular model id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/references", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "Optional, defaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "Optional, defaults to 128 references per page." } ] }, "docs": "Lists model references tied to a particular model id." }, { "info": { "name": "Update model toolkits tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/models/:model_id/toolkits", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Update model toolkits tags" }, { "info": { "name": "PostModelVersionsUnPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/unpublish", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "PostModelVersionsUnPublish" }, { "info": { "name": "Update model use_cases tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/models/:model_id/usecases", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Update model use_cases tags" }, { "info": { "name": "List all the models.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "concept_ids", "value": "", "type": "query", "description": "Filtering options:\nTo list only the model versions that have these concept ids present in them." }, { "name": "trained_only", "value": "", "type": "query", "description": "To list only the model versions that have been trained." }, { "name": "min_replicas", "value": "", "type": "query", "description": "Filter by model versions runners with replicas >= min_replicas." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_status_code", "value": "", "type": "query", "description": "Whether to order by the status code" }, { "name": "sort_by_num_inputs", "value": "", "type": "query", "description": "Whether to order by the number of training inputs" }, { "name": "sort_by_description", "value": "", "type": "query", "description": "Whether to sort by the description" }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time\nIf neither sort option is set to true, will sort by created_at." } ] }, "docs": "List all the models." }, { "info": { "name": "Create a new model version to trigger training of the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/versions", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Create a new model version to trigger training of the model." }, { "info": { "name": "Get the training time estimate based off train request and estimated input count.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/versions/time_estimate", "params": [ { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Get the training time estimate based off train request and estimated input count." }, { "info": { "name": "Deprecated, use GetEvaluation instead\nList the evaluation metrics for a model version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:model_version_id/evaluations", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated, use GetEvaluation instead\nList the evaluation metrics for a model version." }, { "info": { "name": "Deprecated, use PostEvaluations instead", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/versions/:model_version_id/evaluations", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path" } ] }, "docs": "Deprecated, use PostEvaluations instead" }, { "info": { "name": "Deprecated, use GetEvaluation instead\nGet an evaluation metrics for a model version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:model_version_id/evaluations/:evaluation_id", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path" }, { "name": "evaluation_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "fields.confusion_matrix", "value": "", "type": "query" }, { "name": "fields.cooccurrence_matrix", "value": "", "type": "query" }, { "name": "fields.label_counts", "value": "", "type": "query" }, { "name": "fields.binary_metrics", "value": "", "type": "query" }, { "name": "fields.test_set", "value": "", "type": "query" }, { "name": "fields.metrics_by_area", "value": "", "type": "query" }, { "name": "fields.metrics_by_class", "value": "", "type": "query" } ] }, "docs": "Deprecated, use GetEvaluation instead\nGet an evaluation metrics for a model version." }, { "info": { "name": "ListModelVersionInputExamples", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:model_version_id/input_examples", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "id of model the example belongs to" }, { "name": "model_version_id", "value": "", "type": "path", "description": "specific version the example belongs to" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "Optional, defaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "Optional, defaults to 128 references per page." } ] }, "docs": "ListModelVersionInputExamples" }, { "info": { "name": "GetModelVersionInputExample", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:model_version_id/input_examples/:example_id", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "id of model the example belongs to" }, { "name": "model_version_id", "value": "", "type": "path", "description": "specific version the example belongs to" }, { "name": "example_id", "value": "", "type": "path", "description": "Id of example to fetch" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "GetModelVersionInputExample" }, { "info": { "name": "Get a specific model from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific model from an app." }, { "info": { "name": "Delete a single model.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Delete a single model." }, { "info": { "name": "GetModelVersionExport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/exports", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "GetModelVersionExport" }, { "info": { "name": "Export a model", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/exports", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Export a model" }, { "info": { "name": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/inputs", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Get the evaluation metrics for a model version.\nDeprecated: Use GetEvaluation instead\n The server may refuse to accept requests to this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/metrics", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "fields.confusion_matrix", "value": "", "type": "query" }, { "name": "fields.cooccurrence_matrix", "value": "", "type": "query" }, { "name": "fields.label_counts", "value": "", "type": "query" }, { "name": "fields.binary_metrics", "value": "", "type": "query" }, { "name": "fields.test_set", "value": "", "type": "query" }, { "name": "fields.metrics_by_area", "value": "", "type": "query" }, { "name": "fields.metrics_by_class", "value": "", "type": "query" } ] }, "docs": "Get the evaluation metrics for a model version.\nDeprecated: Use GetEvaluation instead\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Deprecated, use PostEvaluations instead\nRun the evaluation metrics for a model version.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/metrics", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Deprecated, use PostEvaluations instead\nRun the evaluation metrics for a model version." }, { "info": { "name": "Get a the output info for a given model_id or model_id/version_id\ncombo.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/output_info", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path", "description": "This is included so that we can re-use this request for multiple\nrpcs with and without the version_id." }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" }, { "name": "trained_before", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets" } ] }, "docs": "Get a the output info for a given model_id or model_id/version_id\ncombo." }, { "info": { "name": "Get predicted outputs from the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/models/:model_id/versions/:version_id/outputs", "params": [ { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Get predicted outputs from the model." }, { "info": { "name": "API Keys in the public API -- request is itself Key authorized, and will tell\nthe user the scopes/access of the key/credential they're providing, as computed by\nour authorizer:", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/my_scopes", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "API Keys in the public API -- request is itself Key authorized, and will tell\nthe user the scopes/access of the key/credential they're providing, as computed by\nour authorizer:" }, { "info": { "name": "API Keys in the public API -- request is itself Key authorized, and will tell\nthe user the scopes/access of the key/credential they're providing, as computed by\nour authorizer:", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/myscopes", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "API Keys in the public API -- request is itself Key authorized, and will tell\nthe user the scopes/access of the key/credential they're providing, as computed by\nour authorizer:" }, { "info": { "name": "V2_MyScopesRoot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/myscopesroot" } }, { "info": { "name": "V2_ListNodepools3", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/nodepools", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "compute_cluster_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "active_usage", "value": "", "type": "query", "description": "Only return nodepools that are actively being used (having runners with\nreplicas >= threshold and pipeline versions scheduled to run)" } ] } }, { "info": { "name": "List all the supported open source licenses in the platform.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/open_source_licenses" }, "docs": "List all the supported open source licenses in the platform." }, { "info": { "name": "This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload.\nThe config must be sent first before the pipeline_step_bytes can be uploaded.\nOnce the config has been sent, the server will respond with a confirmation containing the pipeline_step_version_id.\nThis is so that if your upload is interrupted, you can resume the upload by sending the config again with the pipeline_step_version_id specified for your pipeline_step_version.\nThe actual upload will be done via a multipart upload, the latest successful part_id will be sent from the server in the response to the pipeline_step_bytes.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/pipeline_step_versions/upload" }, "docs": "This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload.\nThe config must be sent first before the pipeline_step_bytes can be uploaded.\nOnce the config has been sent, the server will respond with a confirmation containing the pipeline_step_version_id.\nThis is so that if your upload is interrupted, you can resume the upload by sending the config again with the pipeline_step_version_id specified for your pipeline" }, { "info": { "name": "Lists pipeline templates, which are ready-to-use templates that can simply be run on demand.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/pipeline_templates", "params": [ { "name": "pipeline_template_type", "value": "", "type": "query", "description": "Filter based on PipelineTemplateTypes (e.g. TRAINING)" } ] }, "docs": "Lists pipeline templates, which are ready-to-use templates that can simply be run on demand." }, { "info": { "name": "V2_ListPipelines2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/pipelines", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_GetPipeline2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_ListPipelineVersions2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/pipelines/:pipeline_id/versions", "params": [ { "name": "pipeline_id", "value": "", "type": "path", "description": "List versions for the pipeline identified by this id" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_GetPipelineVersion2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/pipelines/:pipeline_id/versions/:pipeline_version_id", "params": [ { "name": "pipeline_id", "value": "", "type": "path", "description": "The id of the pipeline that has the requested version." }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "Get the identified by this id" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_GetPipelineVersionRun2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/pipelines/:pipeline_id/versions/:pipeline_version_id/runs/:pipeline_version_run_id", "params": [ { "name": "pipeline_id", "value": "", "type": "path", "description": "the ID of the pipeline" }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "The ID of the pipeline version" }, { "name": "pipeline_version_run_id", "value": "", "type": "path", "description": "the ID of the pipeline version run" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] } }, { "info": { "name": "List the resource counts for the app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/resource_counts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "List the resource counts for the app." }, { "info": { "name": "This maintains a single request for asking the API if there is any work to be done, processing\nit and streaming back results.\nTo do that first handshake the MultiRunnerItemOutputResponse will have RUNNER_STREAM_START\nstatus filled in so that the API knows to respond with a MultiRunnerItemResponse.\nFor now there will only be one of those if the model prediction only has one request.\nNOTE(zeiler): downside of this is you can't use HTTP REST requests to do runner work.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/runners/items/process" }, "docs": "This maintains a single request for asking the API if there is any work to be done, processing\nit and streaming back results.\nTo do that first handshake the MultiRunnerItemOutputResponse will have RUNNER_STREAM_START\nstatus filled in so that the API knows to respond with a MultiRunnerItemResponse.\nFor now there will only be one of those if the model prediction only has one request.\nNOTE(zeiler): downside of this is you can't use HTTP REST requests to do runner work." }, { "info": { "name": "List all saved legacy searches.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all saved legacy searches." }, { "info": { "name": "Execute a new search and optionally save it.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/searches" }, "docs": "Deprecated: Use PostInputsSearches or PostAnnotationsSearches instead.\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Patch saved legacy searches by ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/searches" }, "docs": "Patch saved legacy searches by ids." }, { "info": { "name": "Get a saved legacy search.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/searches/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a saved legacy search." }, { "info": { "name": "Execute a previously saved legacy search.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/searches/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID for saves search to be executed" } ] }, "docs": "Execute a previously saved legacy search." }, { "info": { "name": "Delete a saved search.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/searches/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Delete a saved search." }, { "info": { "name": "List all status codes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/status_codes" }, "docs": "List all status codes." }, { "info": { "name": "Get more details for a status code.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/status_codes/:status_code_id", "params": [ { "name": "status_code_id", "value": "", "type": "path" } ] }, "docs": "Get more details for a status code." }, { "info": { "name": "List tasks from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/tasks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "worker_user_ids", "value": "", "type": "query", "description": "Get tasks that have ANY user from this list assigned as worker.\nDeprecated: Use worker_ids." }, { "name": "review_user_ids", "value": "", "type": "query", "description": "Get tasks that have ANY user from this list assigned as reviewer." }, { "name": "label_order_ids", "value": "", "type": "query", "description": "Get tasks that are associated to ANY label order from this list." }, { "name": "including_label_order_tasks", "value": "", "type": "query", "description": "Get label order tasks as well\nIt is automatically set to true if label_order_ids is set." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response.\nCurrently supported additional fields:\n- all\n- worker.users\n- review.users\n- metrics.input_source.inputs_count_estimated\n- metrics.work.inputs_count_estimated\n- metrics.work.inputs_percent_estimated\n- metrics.review.inputs_count_estimated\n- metrics.review.inputs_count_estimated_per_reviewer\n- metrics.review.inputs_percent_estimated\n- metrics.review.inputs_percent_estimated_per_reviewer\n- metrics.review.inputs_reviewable_count_estimated_per_reviewer" }, { "name": "ids", "value": "", "type": "query", "description": "(optional) task IDs to filter on" }, { "name": "input_source_type", "value": "", "type": "query", "description": "(optional) input source type to filter\n\n - ALL_INPUTS: Use all inputs in the app.\n - SAVED_SEARCH: Use the inputs from a saved search.\n - DATASET: Inputs from a dataset.\n - INPUT: Single input (e.g. video livestream input)" }, { "name": "input_source_ids", "value": "", "type": "query", "description": "(optional) ids of input source to be filtered" } ] }, "docs": "List tasks from an app." }, { "info": { "name": "Add tasks to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/tasks" }, "docs": "Add tasks to an app." }, { "info": { "name": "Patch one or more tasks.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/tasks" }, "docs": "Patch one or more tasks." }, { "info": { "name": "Delete multiple tasks in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/tasks" }, "docs": "Delete multiple tasks in one request." }, { "info": { "name": "Get a specific task from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/tasks/:task_id", "params": [ { "name": "task_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response.\nCurrently supported additional fields:\n- all\n- worker.users\n- review.users\n- metrics.input_source.inputs_count_estimated\n- metrics.work.inputs_count_estimated\n- metrics.work.inputs_percent_estimated\n- metrics.review.inputs_count_estimated\n- metrics.review.inputs_count_estimated_per_reviewer\n- metrics.review.inputs_percent_estimated\n- metrics.review.inputs_percent_estimated_per_reviewer\n- metrics.review.inputs_reviewable_count_estimated_per_reviewer" } ] }, "docs": "Get a specific task from an app." }, { "info": { "name": "Task annotation count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/tasks/:task_id/annotations/count", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "task_id for which count per user per status is needed" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "user_ids", "value": "", "type": "query", "description": "Only return counts for these user IDs, effectively operating as an\nOR among them to filter down the results.\nIf model_version_ids or workflow_version_ids are also provided, these user_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Only return counts for these model version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or workflow_version_ids are also provided, these model_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "Only return counts for these workflow version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or model_version_ids are also provided, these workflow_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." } ] }, "docs": "Task annotation count" }, { "info": { "name": "Deprecated: Use PutTaskAssignments with action=LABEL_START.\n This endpoint has initially been designed as a GET request,\n but has been re-designed to serve a PUT logic.\n In order to clearly highlight that this endpoint serves a PUT request,\n this endpoint has been deprecated and replaced by PutTaskAssignments with action=LABEL_START.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/tasks/:task_id/assignments", "params": [ { "name": "task_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Deprecated: Use PutTaskAssignments with action=LABEL_START.\n This endpoint has initially been designed as a GET request,\n but has been re-designed to serve a PUT logic.\n In order to clearly highlight that this endpoint serves a PUT request,\n this endpoint has been deprecated and replaced by PutTaskAssignments with action=LABEL_START." }, { "info": { "name": "Task Input count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/tasks/:task_id/inputs/count", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "task_id for which count per user per status is needed" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "user_ids", "value": "", "type": "query", "description": "Only return counts for these user IDs, effectively operating as an\nOR among them to filter down the results.\nIf model_version_ids or workflow_version_ids are also provided, these user_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Only return counts for these model version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or workflow_version_ids are also provided, these model_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "Only return counts for these workflow version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or model_version_ids are also provided, these workflow_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." } ] }, "docs": "Task Input count" }, { "info": { "name": "V2_GetInputSamples2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/tasks/:task_id/inputs/samples", "params": [ { "name": "task_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "user_ids", "value": "", "type": "query", "description": "URL param. If zero ids provided, returns for all task labelers" } ] } }, { "info": { "name": "V2_ListUploads2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/uploads", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "PostUploads is used to upload files. Note that this does not create inputs.\nreturns job with uploadID, job has UPLOAD_IN_PROGRESS status\nActual upload content can be done in multiple calls with PutUploadContentParts\nYou can get status of upload with GetUpload or ListUploads endpoints\nSee also PostInputsUploads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/uploads" }, "docs": "PostUploads is used to upload files. Note that this does not create inputs.\nreturns job with uploadID, job has UPLOAD_IN_PROGRESS status\nActual upload content can be done in multiple calls with PutUploadContentParts\nYou can get status of upload with GetUpload or ListUploads endpoints\nSee also PostInputsUploads" }, { "info": { "name": "V2_DeleteUploads2", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/uploads" } }, { "info": { "name": "V2_GetUpload2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/uploads/:upload_id", "params": [ { "name": "upload_id", "value": "", "type": "path", "description": "Upload ID" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] } }, { "info": { "name": "Upload a part of a multipart upload.\nBehaviour on completion depends on the endpoint that was used to initiate the upload.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/uploads/:upload_id/content_parts", "params": [ { "name": "upload_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Upload a part of a multipart upload.\nBehaviour on completion depends on the endpoint that was used to initiate the upload." }, { "info": { "name": "Get predicted outputs from the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:runner_selector.deployment.user_id/deployments/:runner_selector.deployment.id/outputs", "params": [ { "name": "runner_selector.deployment.user_id", "value": "", "type": "path", "description": "The user who owns the deployment. These live in the user/org account." }, { "name": "runner_selector.deployment.id", "value": "", "type": "path", "description": "An id for this configured deployment." } ] }, "docs": "Get predicted outputs from the model." }, { "info": { "name": "Patch runners of a user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id_1/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners", "params": [ { "name": "user_app_id.user_id_1", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" } ] }, "docs": "Patch runners of a user." }, { "info": { "name": "V2_StreamLogEntries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id_1/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners/:runner_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id_1", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "runner_id", "value": "", "type": "path" }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Examples: model, agent, build, training." }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "model_id", "value": "", "type": "query", "description": "For models if you set log_type to \"builder\" then you get the model build logs.\nThe Model ID, if a model produced the logs." }, { "name": "model_version_id", "value": "", "type": "query", "description": "The Version ID, if a model version produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "compute_cluster_user_id", "value": "", "type": "query", "description": "Where the logs came from." }, { "name": "pipeline_id", "value": "", "type": "query", "description": "Pipelines that produced the logs with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "query" }, { "name": "pipeline_version_run_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs with log_type: builder\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_StreamLogEntries2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id_1/compute_clusters/:compute_cluster_user_id/:compute_cluster_id/nodepools/:nodepool_id/versions/:model_version_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id_1", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_user_id", "value": "", "type": "path", "description": "Where the logs came from." }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path", "description": "The Version ID, if a model version produced the logs." }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Examples: model, agent, build, training." }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "model_id", "value": "", "type": "query", "description": "For models if you set log_type to \"builder\" then you get the model build logs.\nThe Model ID, if a model produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "runner_id", "value": "", "type": "query" }, { "name": "pipeline_id", "value": "", "type": "query", "description": "Pipelines that produced the logs with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "query" }, { "name": "pipeline_version_run_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs with log_type: builder\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "Get user information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars" } ] }, "docs": "Get user information" }, { "info": { "name": "List all the apps.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, counts" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_name", "value": "", "type": "query", "description": "Whether to order by the name." }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the app" }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the id" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "featured_only", "value": "", "type": "query", "description": "Filtering options:\nIf true, we only return apps that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return apps that are starred by the requesting user" }, { "name": "template_only", "value": "", "type": "query", "description": "If true, we only return apps that are marked as a template by the app owner." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the application:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query various text fields (id, name, description, and notes) that can contain the words in the query string\nDeprecated: use search instead." }, { "name": "name", "value": "", "type": "query", "description": "Filter by the id, name and notes of the app. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "id", "value": "", "type": "query", "description": "Filter by the user-unique-id of the app. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." } ] }, "docs": "List all the apps." }, { "info": { "name": "Add a app to an app.\nThis needs to load the default workflow to make a copy, validating all the models in it, and\nthen writing the new workflow back to this new app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Add a app to an app.\nThis needs to load the default workflow to make a copy, validating all the models in it, and\nthen writing the new workflow back to this new app." }, { "info": { "name": "Patch one or more apps.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Patch one or more apps." }, { "info": { "name": "Patch apps ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/ids", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Patch apps ids." }, { "info": { "name": "Search over the applications to find one or more you're looking for.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Search over the applications to find one or more you're looking for." }, { "info": { "name": "Get a specific app from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, counts" } ] }, "docs": "Get a specific app from an app." }, { "info": { "name": "Patch one app.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one app." }, { "info": { "name": "Search over the apps to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Search over the apps to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request." }, { "info": { "name": "List all the annotation filters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotation_filters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the annotation filters." }, { "info": { "name": "Add annotation filters.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotation_filters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add annotation filters." }, { "info": { "name": "Patch one or more annotation filters.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotation_filters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more annotation filters." }, { "info": { "name": "Delete one or more annotation filters in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotation_filters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete one or more annotation filters in a single request." }, { "info": { "name": "Get a specific annotation filter.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotation_filters/:annotation_filter_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "annotation_filter_id", "value": "", "type": "path", "description": "Identify annotation filter by id." } ] }, "docs": "Get a specific annotation filter." }, { "info": { "name": "Delete multiple annotation tracks in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotation_tracks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple annotation tracks in one request." }, { "info": { "name": "List all the annotation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "List annotations for these IDs" }, { "name": "input_ids", "value": "", "type": "query", "description": "List annotations for these Input IDs\nNote that 'ids' are optional but if the are provided the number and order in\n'ids' and 'input_ids' should match\nIf you do not specify 'ids' all the annotations for 'input_ids' are returned\nIf a you do not specify both 'input_ids' and 'ids' all the annotations in the app are returned" }, { "name": "user_ids", "value": "", "type": "query", "description": "Only return the annotations that has one of these user IDs, effectively operating as an\nOR among them to filter down the results.\nIf model_version_ids or workflow_version_ids are also provided, these user_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request.\nSetting user_ids does also set list_all_annotations=True." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Only return the annotations that has one of these model version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or workflow_version_ids are also provided, these model_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request.\nSetting model_version_ids does also set list_all_annotations=True." }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "Only return the annotations that has one of these workflow version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or model_version_ids are also provided, these workflow_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request.\nSetting workflow_version_ids does also set list_all_annotations=True." }, { "name": "list_all_annotations", "value": "", "type": "query", "description": "Set this flag to list both trusted and not trusted annotations\nby default it's listing only trusted annotations" }, { "name": "return_model_output", "value": "", "type": "query", "description": "Set this flag to return the model output for model annotations in the response." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "task_id", "value": "", "type": "query", "description": "Flag to filter annotations by task_id" } ] }, "docs": "List all the annotation." }, { "info": { "name": "Post annotations.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Post annotations." }, { "info": { "name": "Patch one or more annotations.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more annotations." }, { "info": { "name": "Delete multiple annotations in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple annotations in one request." }, { "info": { "name": "Execute a search over annotations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Execute a search over annotations" }, { "info": { "name": "Patch saved annotations searches by ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch saved annotations searches by ids." }, { "info": { "name": "ListAnnotationWorkers lists users, models, and workflows (collectively\nknown as \"workers\") that have added annotations to the application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/annotations/workers", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response.\nCurrently supported: all, names" }, { "name": "trusted_only", "value": "", "type": "query", "description": "(optional URL parameter) Only list workers that have created trusted annotations." } ] }, "docs": "ListAnnotationWorkers lists users, models, and workflows (collectively\nknown as \"workers\") that have added annotations to the application." }, { "info": { "name": "V2_ListArtifacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostArtifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_DeleteArtifact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_GetArtifact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts/:artifact_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "artifact_id", "value": "", "type": "path", "description": "The id of the artifact to get" } ] } }, { "info": { "name": "V2_ListArtifactVersions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts/:artifact_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "artifact_id", "value": "", "type": "path", "description": "List versions for the artifact identified by this id" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_DeleteArtifactVersion", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts/:artifact_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "artifact_id", "value": "", "type": "path", "description": "The id of the artifact for which versions are being deleted" } ] } }, { "info": { "name": "V2_GetArtifactVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/artifacts/:artifact_id/versions/:artifact_version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "artifact_id", "value": "", "type": "path", "description": "The id of the artifact that has the requested version." }, { "name": "artifact_version_id", "value": "", "type": "path", "description": "Get the artifact version identified by this id" } ] } }, { "info": { "name": "List all the bulk operations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/bulk_operations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the bulk operations" }, { "info": { "name": "Perform bulk operations on a list of inputs based on input source.\nOperation include add, update, delete of concepts, metadata and geo data.\nThis is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/bulk_operations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Perform bulk operations on a list of inputs based on input source.\nOperation include add, update, delete of concepts, metadata and geo data.\nThis is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status." }, { "info": { "name": "Cancel one or more bulk operations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/bulk_operations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Cancel one or more bulk operations" }, { "info": { "name": "delete one or more terminated bulk operations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/bulk_operations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "delete one or more terminated bulk operations" }, { "info": { "name": "Get the bulk operation details by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/bulk_operations/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The bulk operation id" } ] }, "docs": "Get the bulk operation details by ID" }, { "info": { "name": "owner list users who the app is shared with", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/collaborators", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "list_all_collaborators", "value": "", "type": "query", "description": "Set this flag to list both deleted and not deleted collaborators\nby default it's listing only not deleted collaborators" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "owner list users who the app is shared with" }, { "info": { "name": "add collaborators to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/collaborators", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "add collaborators to an app." }, { "info": { "name": "Patch existing collaborators.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/collaborators", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch existing collaborators." }, { "info": { "name": "Delete existing collaborators.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/collaborators", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete existing collaborators." }, { "info": { "name": "List all the concepts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "id", "value": "", "type": "query", "description": "Fuzzy match on concept ID" } ] }, "docs": "List all the concepts." }, { "info": { "name": "Add a concept to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add a concept to an app." }, { "info": { "name": "Patch one or more concepts.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more concepts." }, { "info": { "name": "List all domain graphs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/knowledge_graphs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "List all domain graphs." }, { "info": { "name": "Post domain graphs.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/knowledge_graphs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Post domain graphs." }, { "info": { "name": "List concept relations between concepts in the platform.\nMUST be above ListConcepts so that if concept_id is empty this will still match\n/concepts/relations to list all the concept relations in the app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/relations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "query", "description": "The subject concept id in your app to get all the relationships for.\nLeave as an empty string (GET /concepts/relations) to list ALL the relations in the app.\n\nWhen listing all the relations it will only return one direction of the relationship\nwith the predicate acting on the subject and not the inverse like is done when providing a\nconcept_id so that we can return a reliable page size always.\n\nWhen providing a concept_id, if a hyponym is present in the DB such as:\n'honey' (subject), 'hyponym' (predicate for \"is a kind of\"), 'food' (object)\nthen you can list the concept relations for 'honey' and get hyponym predicate with 'food'\nobject.\nBut you can also list the concept relations for 'food' and it will return the same hyponym\nrelationship with 'honey' as object and 'hypernym' as predicate.\nSynonyms by nature are symmetrical relationships so either side can be the concept_id (subject)\nwhen listing the relations." }, { "name": "predicate", "value": "", "type": "query", "description": "If predicate is provided then only list relations with that predicate.\n\nNote that if no subject is set in concept_id and predicate is set to\n'hypernym', then it will return any stored hyponyms as hypernyms with\njust the subject and object swapped since they are reversed relations.\n\nValid predicates are:\n- 'hypernym'\n- 'hyponym'\n- 'synonym'" }, { "name": "knowledge_graph_id", "value": "", "type": "query", "description": "If knowledge_graph_id is provided then just list relations from that knowledge graph.\nIf not provided then list relations from all knowledge graphs including the global one for this\napp one (ie. knowledge_graph \"\") and any specific ones in the app." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List concept relations between concepts in the platform.\nMUST be above ListConcepts so that if concept_id is empty this will still match\n/concepts/relations to list all the concept relations in the app." }, { "info": { "name": "Search over the concepts to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Search over the concepts to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request." }, { "info": { "name": "List all the concepts with their positive and negative counts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/status", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the concepts with their positive and negative counts" }, { "info": { "name": "Get a specific concept from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path", "description": "The concept's id." } ] }, "docs": "Get a specific concept from an app." }, { "info": { "name": "List the concept in all the translated languages.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/languages", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List the concept in all the translated languages." }, { "info": { "name": "Add a new translation for this concept.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/languages", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path" } ] }, "docs": "Add a new translation for this concept." }, { "info": { "name": "Patch the name for a given language names by passing in a list of concepts with the new names\nfor the languages.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/languages", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path" } ] }, "docs": "Patch the name for a given language names by passing in a list of concepts with the new names\nfor the languages." }, { "info": { "name": "Get a specific concept from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/languages/:language", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path" }, { "name": "language", "value": "", "type": "path", "description": "This is the language identifier." } ] }, "docs": "Get a specific concept from an app." }, { "info": { "name": "List concept relations between concepts in the platform.\nMUST be above ListConcepts so that if concept_id is empty this will still match\n/concepts/relations to list all the concept relations in the app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/relations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path", "description": "The subject concept id in your app to get all the relationships for.\nLeave as an empty string (GET /concepts/relations) to list ALL the relations in the app.\n\nWhen listing all the relations it will only return one direction of the relationship\nwith the predicate acting on the subject and not the inverse like is done when providing a\nconcept_id so that we can return a reliable page size always.\n\nWhen providing a concept_id, if a hyponym is present in the DB such as:\n'honey' (subject), 'hyponym' (predicate for \"is a kind of\"), 'food' (object)\nthen you can list the concept relations for 'honey' and get hyponym predicate with 'food'\nobject.\nBut you can also list the concept relations for 'food' and it will return the same hyponym\nrelationship with 'honey' as object and 'hypernym' as predicate.\nSynonyms by nature are symmetrical relationships so either side can be the concept_id (subject)\nwhen listing the relations." }, { "name": "predicate", "value": "", "type": "query", "description": "If predicate is provided then only list relations with that predicate.\n\nNote that if no subject is set in concept_id and predicate is set to\n'hypernym', then it will return any stored hyponyms as hypernyms with\njust the subject and object swapped since they are reversed relations.\n\nValid predicates are:\n- 'hypernym'\n- 'hyponym'\n- 'synonym'" }, { "name": "knowledge_graph_id", "value": "", "type": "query", "description": "If knowledge_graph_id is provided then just list relations from that knowledge graph.\nIf not provided then list relations from all knowledge graphs including the global one for this\napp one (ie. knowledge_graph \"\") and any specific ones in the app." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List concept relations between concepts in the platform.\nMUST be above ListConcepts so that if concept_id is empty this will still match\n/concepts/relations to list all the concept relations in the app." }, { "info": { "name": "Post concept relations to create relations between concepts in the platform.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/relations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path", "description": "The subject concept id you're going to add relations for." } ] }, "docs": "Post concept relations to create relations between concepts in the platform." }, { "info": { "name": "Post concept relations to create relations between concepts in the platform.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/concepts/:concept_id/relations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "concept_id", "value": "", "type": "path", "description": "The concept to delete relationship for." } ] }, "docs": "Post concept relations to create relations between concepts in the platform." }, { "info": { "name": "List all the datasets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the app" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "If neither sort option is set to true, will sort by modified_at." }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the external id" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "starred_only", "value": "", "type": "query", "description": "Filtering options:" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter datasets by bookmark. If set, only return bookmarked datasets. Otherwise none bookmarked datasets only." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the dataset:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "id", "value": "", "type": "query", "description": "Fuzzy filter on dataset ID\nDeprecated: use search instead." } ] }, "docs": "List all the datasets." }, { "info": { "name": "Add datasets to an app.\nThe process is atomic, i.e. either all or no datasets are added.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add datasets to an app.\nThe process is atomic, i.e. either all or no datasets are added.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error." }, { "info": { "name": "Patch one or more datasets.\nThe process is atomic, i.e. either all or no datasets are patched.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more datasets.\nThe process is atomic, i.e. either all or no datasets are patched.\nIf there is an error for one dataset,\nthe process will stop, revert the transaction and return the error." }, { "info": { "name": "Delete one or more datasets in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete one or more datasets in a single request." }, { "info": { "name": "Get a specific dataset.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "additional_fields", "value": "", "type": "query" } ] }, "docs": "Get a specific dataset." }, { "info": { "name": "List all the dataset inputs in a dataset.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the dataset inputs in a dataset." }, { "info": { "name": "Add dataset inputs to a dataset.\nThe process is not atomic, i.e. if there are errors with some dataset\ninputs, others might still be added. The response reports\n - SUCCESS if all dataset inputs were added,\n - MIXED_STATUS if only some dataset inputs were added, and\n - FAILURE if no dataset inputs were added.\nEach individual dataset input in the response has the status set to\nindicate if it was successful or if there was an error.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Add dataset inputs to a dataset.\nThe process is not atomic, i.e. if there are errors with some dataset\ninputs, others might still be added. The response reports\n - SUCCESS if all dataset inputs were added,\n - MIXED_STATUS if only some dataset inputs were added, and\n - FAILURE if no dataset inputs were added.\nEach individual dataset input in the response has the status set to\nindicate if it was successful or if there was an error." }, { "info": { "name": "Delete one or more dataset inputs in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Delete one or more dataset inputs in a single request." }, { "info": { "name": "Get a specific dataset input.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/inputs/:input_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "input_id", "value": "", "type": "path", "description": "Identify dataset input by id." } ] }, "docs": "Get a specific dataset input." }, { "info": { "name": "List all the dataset versions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "request_origins", "value": "", "type": "query", "description": "(optional URL parameter) Filter by origin of dataset version" } ] }, "docs": "List all the dataset versions." }, { "info": { "name": "Add dataset versions to a dataset.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Add dataset versions to a dataset." }, { "info": { "name": "Patch one or more dataset versions.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Patch one or more dataset versions." }, { "info": { "name": "Delete one or more dataset versions in a single request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." } ] }, "docs": "Delete one or more dataset versions in a single request." }, { "info": { "name": "Get a specific dataset version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions/:dataset_version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "dataset_version_id", "value": "", "type": "path", "description": "Identify dataset version by id." } ] }, "docs": "Get a specific dataset version." }, { "info": { "name": "Create export of a dataset version.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions/:dataset_version_id/exports", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "dataset_version_id", "value": "", "type": "path", "description": "Identify dataset version by id." } ] }, "docs": "Create export of a dataset version." }, { "info": { "name": "V2_ListDatasetVersionMetricsGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/datasets/:dataset_id/versions/:dataset_version_id/metrics", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path", "description": "Identify dataset by id." }, { "name": "dataset_version_id", "value": "", "type": "path", "description": "Identify dataset version by id." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "parent_paths", "value": "", "type": "query", "description": "Filter by parent path. Multiple parent paths are OR-ed. Empty list results in no filter." }, { "name": "types", "value": "", "type": "query", "description": "Filter by parent type. Multiple types are OR-ed. Empty list results in no filter.\n\n - INPUT_TYPE: Group data examples by input type.\nExamples: images, videos, text, audio.\n - CONCEPT_ID: Group data examples by concept ID.\nExamples: inputs with cat concept, inputs with dog concept.\n - CONCEPTS_COUNT: Group data examples by concepts count.\nExamples: inputs with 20 concepts, inputs with 21 concepts.\n - BOUNDING_BOXES_COUNT: Group data examples by bounding boxes count.\nExamples: inputs with 20 bounding boxes, inputs with 21 bounding boxes.\n - POLYGONS_COUNT: Group data examples by polygons count.\nExamples: inputs with 20 polygons, inputs with 21 polygons.\n - POINTS_COUNT: Group data examples by points count.\nExamples: inputs with 20 points, inputs with 21 points.\n - MASKS_COUNT: Group data examples by masks count.\nExamples: inputs with 20 masks, inputs with 21 masks.\n - PIXELS_COUNT: Group data examples by pixels count.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 400: inputs with [200000, 200400) pixels, inputs with [200400, 200800) pixels.\n - ASPECT_RATIO: Group data examples by aspect ratio.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 0.1: inputs with [0.5, 0.6) aspect ratio, inputs with [0.6, 0.7) aspect ratio." } ] } }, { "info": { "name": "Deprecated: App duplication is no longer supported.\nPostAppDuplications starts async app duplication jobs which copy resources\n(inputs, annotations, models etc) from one application to another.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/duplications", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Deprecated: App duplication is no longer supported.\nPostAppDuplications starts async app duplication jobs which copy resources\n(inputs, annotations, models etc) from one application to another." }, { "info": { "name": "V2_ListEvaluations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "If true, sort in ascending order, otherwise sort in descending order." }, { "name": "sort_by_app_id", "value": "", "type": "query", "description": "Whether to order by application id" }, { "name": "sort_by_roc_auc", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_roc_auc" }, { "name": "sort_by_f1", "value": "", "type": "query", "description": "Whether to order by eval metric summary.f1" }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by when the metric was created" }, { "name": "sort_by_mean_avg_precision", "value": "", "type": "query", "description": "Whether to order by eval metric summary.mean_avg_precision_iou_50" }, { "name": "sort_by_precision", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_precision" }, { "name": "sort_by_recall", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_recall" }, { "name": "sort_by_model_id", "value": "", "type": "query" }, { "name": "sort_by_eval_dataset_id", "value": "", "type": "query" }, { "name": "sort_by_train_dataset_id", "value": "", "type": "query" }, { "name": "model_type_id", "value": "", "type": "query", "description": "Filter on model type id" }, { "name": "eval_dataset_ids", "value": "", "type": "query", "description": "Filter on dataset ID of the dataset version specified in the metric version" }, { "name": "train_dataset_ids", "value": "", "type": "query", "description": "Filter on dataset ID of the dataset version specified by the model version" }, { "name": "concept_ids", "value": "", "type": "query", "description": "Filter on concept IDs specified in the modele version's output_info" }, { "name": "show_failed_metrics", "value": "", "type": "query", "description": "Whether to show failed metrics, defaults to false" } ] } }, { "info": { "name": "V2_PostEvaluations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_GetEvaluation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/evaluations/:evaluation_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "evaluation_id", "value": "", "type": "path" }, { "name": "fields.confusion_matrix", "value": "", "type": "query" }, { "name": "fields.cooccurrence_matrix", "value": "", "type": "query" }, { "name": "fields.label_counts", "value": "", "type": "query" }, { "name": "fields.binary_metrics", "value": "", "type": "query" }, { "name": "fields.test_set", "value": "", "type": "query" }, { "name": "fields.metrics_by_area", "value": "", "type": "query" }, { "name": "fields.metrics_by_class", "value": "", "type": "query" } ] } }, { "info": { "name": "List all the inputs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "status.code", "value": "", "type": "query", "description": "Status code from internal codes.\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" }, { "name": "status.description", "value": "", "type": "query", "description": "A short description of the error." }, { "name": "status.details", "value": "", "type": "query", "description": "More details of the given error.\nThese details may be exposed to non-technical users.\nFor technical details, try to use developer_notes field." }, { "name": "status.stack_trace", "value": "", "type": "query", "description": "For some environment we may return a stack trace to help debug\nany issues." }, { "name": "status.percent_completed", "value": "", "type": "query", "description": "specifically for long running jobs" }, { "name": "status.time_remaining", "value": "", "type": "query", "description": "if status is pending, how much time is remaining (in seconds)" }, { "name": "status.req_id", "value": "", "type": "query", "description": "A request ID may be present, to help monitoring and tracking requests" }, { "name": "status.internal_details", "value": "", "type": "query", "description": "Internal Annotation (do not set in production, for internal Clarifai use only)." }, { "name": "status.redirect_info.url", "value": "", "type": "query", "description": "New location for the resource. Used to set response Location header." }, { "name": "status.redirect_info.resource_type", "value": "", "type": "query", "description": "Resource type" }, { "name": "status.redirect_info.old_resource_id", "value": "", "type": "query", "description": "Old resource id" }, { "name": "status.redirect_info.new_resource_id", "value": "", "type": "query", "description": "New resource id" }, { "name": "status.developer_notes", "value": "", "type": "query", "description": "Notes for developer.\nThese notes are rather technical details for developers how to interpret the status,\ne.g. why an error occurred and how to avoid getting the error." }, { "name": "status.http_status_code", "value": "", "type": "query", "description": "The HTTP status code of the response." }, { "name": "ids", "value": "", "type": "query" } ] }, "docs": "List all the inputs." }, { "info": { "name": "PostInputs adds one or more inputs to the app.\nTakes a list of image/video/audio/text URLs, image/video/audio bytes or raw text\nOptionally, include concepts or dataset ids to link them\nOptionally, include metadata for search\nNote that inputs processing is asynchronous process\nSee ListInputs, StreamInputs or PostInputSearches to list results", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "PostInputs adds one or more inputs to the app.\nTakes a list of image/video/audio/text URLs, image/video/audio bytes or raw text\nOptionally, include concepts or dataset ids to link them\nOptionally, include metadata for search\nNote that inputs processing is asynchronous process\nSee ListInputs, StreamInputs or PostInputSearches to list results" }, { "info": { "name": "Patch one or more inputs.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more inputs." }, { "info": { "name": "Delete multiple inputs in one request.\nThis call is asynchronous.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple inputs in one request.\nThis call is asynchronous." }, { "info": { "name": "Delete multiple annotations in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/annotations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple annotations in one request." }, { "info": { "name": "Initiates retrieval of inputs from cloud storage from a user provided data source.\nWill create and return an inputs-add-job for tracking progress.\nArchives will be extracted and their contents will be processed as inputs.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/data_sources", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "The cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process\nfiles in the images_folder beginning with abc or in a subfolder beginning with abc.\nFor example:\nbucket/images_folder/abcImage.png\nbucket/images_folder/abc-1/Data.zip\n\nIf given URL is for a private bucket or file, then credentials should be provided to access the bucket.\nCredentials should include rights to list the objects in the bucket, except when pointed directly at a file archive,\nin whic" }, { "info": { "name": "List all the inputs add jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/jobs/add", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the inputs add jobs" }, { "info": { "name": "Get the input add job details by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/jobs/add/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "id of add inputs job" } ] }, "docs": "Get the input add job details by ID" }, { "info": { "name": "cancel the input add job by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/jobs/add/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "id of add inputs job to be cancelled" } ] }, "docs": "cancel the input add job by ID" }, { "info": { "name": "List all the input extraction jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/jobs/extraction", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the input extraction jobs" }, { "info": { "name": "V2_CancelInputsExtractionJobs", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/jobs/extraction", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "Get the input extraction job details by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/jobs/extraction/:inputs_extraction_job_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "inputs_extraction_job_id", "value": "", "type": "path" } ] }, "docs": "Get the input extraction job details by ID" }, { "info": { "name": "Execute a search over inputs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Execute a search over inputs" }, { "info": { "name": "Patch saved inputs searches by ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch saved inputs searches by ids." }, { "info": { "name": "Get input count per status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/status", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Get input count per status." }, { "info": { "name": "Streams all the inputs starting from oldest assets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/stream", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 20." }, { "name": "last_id", "value": "", "type": "query" }, { "name": "order_by_id", "value": "", "type": "query", "description": "By default, the endpoint return inputs by the time when it is added.\nIf this is set to true, we will return inputs by id." }, { "name": "descending", "value": "", "type": "query" } ] }, "docs": "Streams all the inputs starting from oldest assets." }, { "info": { "name": "Create new upload job with a file archive containing inputs (images, videos, text, audio)\nActual file upload happens in next steps by calling `PutUploadContentParts` endpoint\nand providing the file content in the request body.\nThis endpoint creates and return an inputs-add-job which contains an upload id needed for upload and further status tracking\nCompleting the upload will automatically begin unpacking the archive and uploading the contents as inputs.\nSee also GetInputsAddJob and then GetInputsExtractionJob", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/uploads", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Create new upload job with a file archive containing inputs (images, videos, text, audio)\nActual file upload happens in next steps by calling `PutUploadContentParts` endpoint\nand providing the file content in the request body.\nThis endpoint creates and return an inputs-add-job which contains an upload id needed for upload and further status tracking\nCompleting the upload will automatically begin unpacking the archive and uploading the contents as inputs.\nSee also GetInputsAddJob and then GetInpu" }, { "info": { "name": "Get a specific input from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Get a specific input from an app." }, { "info": { "name": "Delete a single input asynchronously.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Delete a single input asynchronously." }, { "info": { "name": "List all the annotation tracks.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/annotation_tracks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "List all the annotation tracks." }, { "info": { "name": "Post annotation tracks.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/annotation_tracks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Post annotation tracks." }, { "info": { "name": "Patch one or more annotation tracks.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/annotation_tracks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more annotation tracks." }, { "info": { "name": "Stream live video annotations as soon as they are available.\nThis endpoint will NOT replay old annotations, but only stream new annotations that are generated after the stream is opened.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/annotations/stream/live", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path", "description": "The input ID containing the video being processed" } ] }, "docs": "Stream live video annotations as soon as they are available.\nThis endpoint will NOT replay old annotations, but only stream new annotations that are generated after the stream is opened." }, { "info": { "name": "Get a specific annotation from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/annotations/:annotation_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" }, { "name": "annotation_id", "value": "", "type": "path" } ] }, "docs": "Get a specific annotation from an app." }, { "info": { "name": "Delete a single annotation.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/annotations/:annotation_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" }, { "name": "annotation_id", "value": "", "type": "path" } ] }, "docs": "Delete a single annotation." }, { "info": { "name": "List video track annotations for a specific input.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/track_annotations/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path", "description": "The input ID containing the video track annotations to list" } ] }, "docs": "List video track annotations for a specific input." }, { "info": { "name": "Stream annotations for a specific input one-by-one.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/track_annotations/searches/stream", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path", "description": "The input ID containing the annotations to stream" } ] }, "docs": "Stream annotations for a specific input one-by-one." }, { "info": { "name": "Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs and successfully processed\nExperimental. Manifest is used by browser and desktop clients that implement an efficient streaming playback\nThis means client can switch between low-resolution and high-resolution video streams\nDepending on network bandwidth or user's preference\nThis also means that reencoded video streams are reencoded in a uniform way, not relying on original format\nAlternative to MPEG-dash is to stream original file with byte-range header", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/inputs/:input_id/video_manifest", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "input_id", "value": "", "type": "path" } ] }, "docs": "Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs and successfully processed\nExperimental. Manifest is used by browser and desktop clients that implement an efficient streaming playback\nThis means client can switch between low-resolution and high-resolution video streams\nDepending on network bandwidth or user's preference\nThis also means that reencoded video streams are reencoded in a uniform way, not relying on original format\nAlternative to MPEG-dash is to stream or" }, { "info": { "name": "List keys by app_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/keys", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List keys by app_id" }, { "info": { "name": "List label orders.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/label_orders", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List label orders." }, { "info": { "name": "Add Label orders.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/label_orders", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add Label orders." }, { "info": { "name": "Patch one or more label orders.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/label_orders", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more label orders." }, { "info": { "name": "Delete multiple label orders in one request.\nthis do not change task status", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/label_orders", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple label orders in one request.\nthis do not change task status" }, { "info": { "name": "Get a label order.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/label_orders/:label_order_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "label_order_id", "value": "", "type": "path" } ] }, "docs": "Get a label order." }, { "info": { "name": "List all the models.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets, counts" }, { "name": "show_replicas", "value": "", "type": "query", "description": "If true, show replica counts for models." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_name", "value": "", "type": "query", "description": "Whether to order by the name" }, { "name": "sort_by_num_inputs", "value": "", "type": "query", "description": "Whether to order by the number of training inputs" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time of the latest model version.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at" }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by count of stars" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "model_type_id", "value": "", "type": "query", "description": "Filtering options:\nFilter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id's\nsupported." }, { "name": "trained_only", "value": "", "type": "query", "description": "If true, we only return models that have the status MODEL_TRAINED, which includes non-trainable model types." }, { "name": "input_fields", "value": "", "type": "query", "description": "The list of input fields to the model.\nFor example, you can specify 'image', which will return models that make inferences on images like visual-classifier models." }, { "name": "output_fields", "value": "", "type": "query", "description": "The list of output fields to the model.\nFor example, you can specify 'regions[...].data.concepts', which will return visual-detector models." }, { "name": "license", "value": "", "type": "query", "description": "Filter by the license of the model version" }, { "name": "featured_only", "value": "", "type": "query", "description": "If true, we only return models that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return models that are starred by the requesting user" }, { "name": "toolkits", "value": "", "type": "query", "description": "List of toolkit tags to filter by" }, { "name": "use_cases", "value": "", "type": "query", "description": "List of use_case tags to filter by" }, { "name": "languages", "value": "", "type": "query", "description": "List of language tags to filter by" }, { "name": "dont_fetch_from_main", "value": "", "type": "query", "description": "Old API behavior resulted in returning clarifai main models when calling ListModels while scoped to an app. While we transition\naway from that, we can use this flag to not always fetch clarifai main models, unless that is the app we are explicitly listing for.\n\n@exclude TODO (EAGLE-4447): Remove this field" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter models by bookmark. If set, only return bookmarked models. Otherwise none bookmarked models only.\nNote: you can not filter `trained_only` and bookmark at the same time.\nWhen filter by bookmark, we will return trained and untrained models." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Filter by the model version ids. If set, only return the model of these versions." }, { "name": "license_type", "value": "", "type": "query", "description": "Filter by LicenseType" }, { "name": "source", "value": "", "type": "query", "description": "Filter by Source" }, { "name": "creator", "value": "", "type": "query", "description": "Filter by Creator" }, { "name": "min_replicas", "value": "", "type": "query", "description": "Filter by model versions runners with replicas >= min_replicas." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the model:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query name, description and id fields, that can contain the words in the query string. Does NOT support wildcards - full words only. Supports operators \"OR\" and \"-\" as NOT.\nDeprecated: use search instead." }, { "name": "name", "value": "", "type": "query", "description": "Filter by the description and id of the model. This supports wildcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "filter_by_user_id", "value": "", "type": "query", "description": "Extends the name filter to include the user_id of the application owner that the model belongs to.\nDeprecated: use search instead of name." } ] }, "docs": "List all the models." }, { "info": { "name": "Add a models to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add a models to an app." }, { "info": { "name": "Patch one or more models.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more models." }, { "info": { "name": "Delete multiple models in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple models in one request." }, { "info": { "name": "Patch one or more models ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/ids", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more models ids." }, { "info": { "name": "Search over the models to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Search over the models to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request." }, { "info": { "name": "List all the model types available in the platform.\nThis MUST be above ListModels so that the /models/types endpoint takes precedence.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/types", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all the model types available in the platform.\nThis MUST be above ListModels so that the /models/types endpoint takes precedence." }, { "info": { "name": "Get a specific model type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/types/:model_type_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_type_id", "value": "", "type": "path", "description": "The specific ModelType.Id you want to retrieve." } ] }, "docs": "Get a specific model type." }, { "info": { "name": "Get a specific model from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "query", "description": "This is included so that we can re-use this request for multiple\nrpcs with and without the version_id." }, { "name": "language", "value": "", "type": "query" }, { "name": "trained_before", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets" } ] }, "docs": "Get a specific model from an app." }, { "info": { "name": "Delete a single model.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Delete a single model." }, { "info": { "name": "Update model check consents", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/check_consents", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path", "description": "the model id" } ] }, "docs": "Update model check consents" }, { "info": { "name": "List models concepts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/concepts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path", "description": "Model id" }, { "name": "version_id", "value": "", "type": "query", "description": "Model version Id. Optional, if not provided latest model version is used." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the concept:\n - id\n - name\n\nKeywords are used for partial prefix-matching (so searching for \"larif\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." } ] }, "docs": "List models concepts." }, { "info": { "name": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Update model languages tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/languages", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Update model languages tags" }, { "info": { "name": "Kicks off conversion from the old Triton model format to the new Docker model format.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/migration", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Kicks off conversion from the old Triton model format to the new Docker model format." }, { "info": { "name": "Reverts a model migration from Docker format back to Triton format.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/migration", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Reverts a model migration from Docker format back to Triton format." }, { "info": { "name": "Get a the output info for a given model_id or model_id/version_id\ncombo.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/output_info", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "query", "description": "This is included so that we can re-use this request for multiple\nrpcs with and without the version_id." }, { "name": "language", "value": "", "type": "query" }, { "name": "trained_before", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets" } ] }, "docs": "Get a the output info for a given model_id or model_id/version_id\ncombo." }, { "info": { "name": "Get predicted outputs from the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/outputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Get predicted outputs from the model." }, { "info": { "name": "TODO(zeiler): will need to\nSingle request but streaming responses.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/outputs/generate", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "TODO(zeiler): will need to\nSingle request but streaming responses." }, { "info": { "name": "PostModelVersionsPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/publish", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "PostModelVersionsPublish" }, { "info": { "name": "Lists model references tied to a particular model id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/references", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "Optional, defaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "Optional, defaults to 128 references per page." } ] }, "docs": "Lists model references tied to a particular model id." }, { "info": { "name": "Update model toolkits tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/toolkits", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Update model toolkits tags" }, { "info": { "name": "PostModelVersionsUnPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/unpublish", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "PostModelVersionsUnPublish" }, { "info": { "name": "Update model use_cases tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/usecases", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Update model use_cases tags" }, { "info": { "name": "List all the models.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "concept_ids", "value": "", "type": "query", "description": "Filtering options:\nTo list only the model versions that have these concept ids present in them." }, { "name": "trained_only", "value": "", "type": "query", "description": "To list only the model versions that have been trained." }, { "name": "min_replicas", "value": "", "type": "query", "description": "Filter by model versions runners with replicas >= min_replicas." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_status_code", "value": "", "type": "query", "description": "Whether to order by the status code" }, { "name": "sort_by_num_inputs", "value": "", "type": "query", "description": "Whether to order by the number of training inputs" }, { "name": "sort_by_description", "value": "", "type": "query", "description": "Whether to sort by the description" }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time\nIf neither sort option is set to true, will sort by created_at." } ] }, "docs": "List all the models." }, { "info": { "name": "Create a new model version to trigger training of the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Create a new model version to trigger training of the model." }, { "info": { "name": "PatchModelVersions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "PatchModelVersions" }, { "info": { "name": "Get the training time estimate based off train request and estimated input count.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/time_estimate", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" } ] }, "docs": "Get the training time estimate based off train request and estimated input count." }, { "info": { "name": "Deprecated, use GetEvaluation instead\nList the evaluation metrics for a model version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:model_version_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated, use GetEvaluation instead\nList the evaluation metrics for a model version." }, { "info": { "name": "Deprecated, use PostEvaluations instead", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:model_version_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path" } ] }, "docs": "Deprecated, use PostEvaluations instead" }, { "info": { "name": "Deprecated, use GetEvaluation instead\nGet an evaluation metrics for a model version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:model_version_id/evaluations/:evaluation_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path" }, { "name": "evaluation_id", "value": "", "type": "path" }, { "name": "fields.confusion_matrix", "value": "", "type": "query" }, { "name": "fields.cooccurrence_matrix", "value": "", "type": "query" }, { "name": "fields.label_counts", "value": "", "type": "query" }, { "name": "fields.binary_metrics", "value": "", "type": "query" }, { "name": "fields.test_set", "value": "", "type": "query" }, { "name": "fields.metrics_by_area", "value": "", "type": "query" }, { "name": "fields.metrics_by_class", "value": "", "type": "query" } ] }, "docs": "Deprecated, use GetEvaluation instead\nGet an evaluation metrics for a model version." }, { "info": { "name": "ListModelVersionInputExamples", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:model_version_id/input_examples", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path", "description": "id of model the example belongs to" }, { "name": "model_version_id", "value": "", "type": "path", "description": "specific version the example belongs to" }, { "name": "page", "value": "", "type": "query", "description": "Optional, defaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "Optional, defaults to 128 references per page." } ] }, "docs": "ListModelVersionInputExamples" }, { "info": { "name": "GetModelVersionInputExample", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:model_version_id/input_examples/:example_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path", "description": "id of model the example belongs to" }, { "name": "model_version_id", "value": "", "type": "path", "description": "specific version the example belongs to" }, { "name": "example_id", "value": "", "type": "path", "description": "Id of example to fetch" } ] }, "docs": "GetModelVersionInputExample" }, { "info": { "name": "V2_ListLogEntries4", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:model_version_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model ID, if a model produced the logs." }, { "name": "model_version_id", "value": "", "type": "path", "description": "The Version ID, if a model version produced the logs." }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run]" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to last page." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 32." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "compute_cluster_user_id", "value": "", "type": "query", "description": "Where the logs came from." }, { "name": "compute_cluster_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query" }, { "name": "runner_id", "value": "", "type": "query" }, { "name": "pipeline_id", "value": "", "type": "query", "description": "Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "query" }, { "name": "pipeline_version_run_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "Get a specific model from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Get a specific model from an app." }, { "info": { "name": "Delete a single model.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Delete a single model." }, { "info": { "name": "List models concepts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/concepts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path", "description": "Model id" }, { "name": "version_id", "value": "", "type": "path", "description": "Model version Id. Optional, if not provided latest model version is used." }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the concept:\n - id\n - name\n\nKeywords are used for partial prefix-matching (so searching for \"larif\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." } ] }, "docs": "List models concepts." }, { "info": { "name": "GetModelVersionExport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/exports", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "GetModelVersionExport" }, { "info": { "name": "Export a model", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/exports", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Export a model" }, { "info": { "name": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/inputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated: Unmaintained and ideally replaced with usage of datasets\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Get the evaluation metrics for a model version.\nDeprecated: Use GetEvaluation instead\n The server may refuse to accept requests to this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/metrics", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "fields.confusion_matrix", "value": "", "type": "query" }, { "name": "fields.cooccurrence_matrix", "value": "", "type": "query" }, { "name": "fields.label_counts", "value": "", "type": "query" }, { "name": "fields.binary_metrics", "value": "", "type": "query" }, { "name": "fields.test_set", "value": "", "type": "query" }, { "name": "fields.metrics_by_area", "value": "", "type": "query" }, { "name": "fields.metrics_by_class", "value": "", "type": "query" } ] }, "docs": "Get the evaluation metrics for a model version.\nDeprecated: Use GetEvaluation instead\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Deprecated, use PostEvaluations instead\nRun the evaluation metrics for a model version.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/metrics", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Deprecated, use PostEvaluations instead\nRun the evaluation metrics for a model version." }, { "info": { "name": "Kicks off conversion from the old Triton model format to the new Docker model format.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/migration", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Kicks off conversion from the old Triton model format to the new Docker model format." }, { "info": { "name": "Get a the output info for a given model_id or model_id/version_id\ncombo.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/output_info", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path", "description": "This is included so that we can re-use this request for multiple\nrpcs with and without the version_id." }, { "name": "language", "value": "", "type": "query" }, { "name": "trained_before", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets" } ] }, "docs": "Get a the output info for a given model_id or model_id/version_id\ncombo." }, { "info": { "name": "Get predicted outputs from the model.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/outputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Get predicted outputs from the model." }, { "info": { "name": "TODO(zeiler): will need to\nSingle request but streaming responses.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/models/:model_id/versions/:version_id/outputs/generate", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "model_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "TODO(zeiler): will need to\nSingle request but streaming responses." }, { "info": { "name": "API Keys in the public API -- request is itself Key authorized, and will tell\nthe user the scopes/access of the key/credential they're providing, as computed by\nour authorizer:", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/myscopes", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "API Keys in the public API -- request is itself Key authorized, and will tell\nthe user the scopes/access of the key/credential they're providing, as computed by\nour authorizer:" }, { "info": { "name": "Allows to Patch only the below fields in one or more apps.\nAllowed fields are notes, description and image", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/partial", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Allows to Patch only the below fields in one or more apps.\nAllowed fields are notes, description and image" }, { "info": { "name": "V2_ListPipelineSteps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostPipelineSteps", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_DeletePipelineSteps", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_GetPipelineStep", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps/:pipeline_step_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_step_id", "value": "", "type": "path", "description": "The id of the pipeline step that has the requested version." } ] } }, { "info": { "name": "V2_ListPipelineStepVersions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps/:pipeline_step_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_step_id", "value": "", "type": "path", "description": "List versions for the pipeline step identified by this id" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "status_codes", "value": "", "type": "query", "description": "Filter based on status\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" } ] } }, { "info": { "name": "V2_DeletePipelineStepVersions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps/:pipeline_step_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_step_id", "value": "", "type": "path", "description": "The id of the pipeline step for which versions are being deleted" } ] } }, { "info": { "name": "V2_GetPipelineStepVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_steps/:pipeline_step_id/versions/:pipeline_step_version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_step_id", "value": "", "type": "path", "description": "The id of the pipeline step that has the requested version." }, { "name": "pipeline_step_version_id", "value": "", "type": "path", "description": "Get the identified by this id" } ] } }, { "info": { "name": "Creates a Pipeline, PipelineVersion, and PipelineVersionRun from a PipelineTemplate.\nThis is a convenience endpoint for users to quickly get started with running pipelines.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipeline_templates/:pipeline_template_name/pipeline_version_runs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_template_name", "value": "", "type": "path", "description": "Name of the pipeline template to use (from ListPipelineTemplates)" } ] }, "docs": "Creates a Pipeline, PipelineVersion, and PipelineVersionRun from a PipelineTemplate.\nThis is a convenience endpoint for users to quickly get started with running pipelines." }, { "info": { "name": "V2_ListPipelines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostPipelines", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_PatchPipelines", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_DeletePipelines", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_GetPipeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_ListPipelineVersions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "List versions for the pipeline identified by this id" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PatchPipelineVersions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "The id of the Pipeline that has the requested versions to patch." } ] } }, { "info": { "name": "V2_DeletePipelineVersions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "The id of the Pipeline for which versions are being deleted" } ] } }, { "info": { "name": "V2_GetPipelineVersion", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "The id of the pipeline that has the requested version." }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "Get the identified by this id" } ] } }, { "info": { "name": "putting above the Get Nodepool endpoint to make it appear above the other one", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "The ID of the pipeline" }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "The ID of the pipeline version" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "status_codes", "value": "", "type": "query", "description": "Filter based on status\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" }, { "name": "compute_cluster_id", "value": "", "type": "query", "description": "compute cluster id" }, { "name": "nodepool_id", "value": "", "type": "query", "description": "nodepool id" } ] }, "docs": "putting above the Get Nodepool endpoint to make it appear above the other one" }, { "info": { "name": "V2_PostPipelineVersionRuns", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "The ID of the pipeline" }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "The ID of the pipeline-version" } ] } }, { "info": { "name": "V2_PatchPipelineVersionRuns", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "The ID of the pipeline" }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "The ID of the pipeline-version" } ] } }, { "info": { "name": "V2_GetPipelineVersionRun", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs/:pipeline_version_run_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "the ID of the pipeline" }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "The ID of the pipeline version" }, { "name": "pipeline_version_run_id", "value": "", "type": "path", "description": "the ID of the pipeline version run" } ] } }, { "info": { "name": "V2_ListPipelineVersionRunStatusLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs/:pipeline_version_run_id/status_logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "Pipeline ID" }, { "name": "pipeline_version_id", "value": "", "type": "path", "description": "Pipeline Version ID" }, { "name": "pipeline_version_run_id", "value": "", "type": "path", "description": "Pipeline Version Run ID" }, { "name": "status_codes", "value": "", "type": "query", "description": "Status codes to filter by (optional)\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" }, { "name": "page", "value": "", "type": "query", "description": "Pagination" }, { "name": "per_page", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_ListLogEntries5", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs/:pipeline_version_run_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "path" }, { "name": "pipeline_version_run_id", "value": "", "type": "path" }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run]" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to last page." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 32." }, { "name": "model_id", "value": "", "type": "query", "description": "The Model ID, if a model produced the logs." }, { "name": "model_version_id", "value": "", "type": "query", "description": "The Version ID, if a model version produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "compute_cluster_user_id", "value": "", "type": "query", "description": "Where the logs came from." }, { "name": "compute_cluster_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query" }, { "name": "runner_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_StreamLogEntries3", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/pipelines/:pipeline_id/versions/:pipeline_version_id/runs/:pipeline_version_run_id/:log_type/stream/logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "pipeline_id", "value": "", "type": "path", "description": "Pipelines that produced the logs with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "path" }, { "name": "pipeline_version_run_id", "value": "", "type": "path" }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Examples: model, agent, build, training." }, { "name": "model_id", "value": "", "type": "query", "description": "For models if you set log_type to \"builder\" then you get the model build logs.\nThe Model ID, if a model produced the logs." }, { "name": "model_version_id", "value": "", "type": "query", "description": "The Version ID, if a model version produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "compute_cluster_user_id", "value": "", "type": "query", "description": "Where the logs came from." }, { "name": "compute_cluster_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query" }, { "name": "runner_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs with log_type: builder\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "List the resource counts for the app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/resource_counts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "List the resource counts for the app." }, { "info": { "name": "Post task metrics from runner replicas.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/runner_replica_task_metrics", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Post task metrics from runner replicas." }, { "info": { "name": "List all saved legacy searches.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List all saved legacy searches." }, { "info": { "name": "Execute a new search and optionally save it.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Deprecated: Use PostInputsSearches or PostAnnotationsSearches instead.\n The server may refuse to accept requests to this endpoint." }, { "info": { "name": "Patch saved legacy searches by ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch saved legacy searches by ids." }, { "info": { "name": "Get a saved legacy search.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/searches/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a saved legacy search." }, { "info": { "name": "Execute a previously saved legacy search.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/searches/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "ID for saves search to be executed" } ] }, "docs": "Execute a previously saved legacy search." }, { "info": { "name": "Delete a saved search.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/searches/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a saved search." }, { "info": { "name": "Patch annotations status by worker id and task id.\nDeprecated: Use PutTaskAssignments to update task annotations.\n For example, you can use PutTaskAssignments with action REVIEW_APPROVE\n to approve task assignments and associated annotations in bulk.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/task/:task_id/annotations/status", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path", "description": "Filter by task ID" } ] }, "docs": "Patch annotations status by worker id and task id.\nDeprecated: Use PutTaskAssignments to update task annotations.\n For example, you can use PutTaskAssignments with action REVIEW_APPROVE\n to approve task assignments and associated annotations in bulk." }, { "info": { "name": "List tasks from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "worker_user_ids", "value": "", "type": "query", "description": "Get tasks that have ANY user from this list assigned as worker.\nDeprecated: Use worker_ids." }, { "name": "review_user_ids", "value": "", "type": "query", "description": "Get tasks that have ANY user from this list assigned as reviewer." }, { "name": "label_order_ids", "value": "", "type": "query", "description": "Get tasks that are associated to ANY label order from this list." }, { "name": "including_label_order_tasks", "value": "", "type": "query", "description": "Get label order tasks as well\nIt is automatically set to true if label_order_ids is set." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response.\nCurrently supported additional fields:\n- all\n- worker.users\n- review.users\n- metrics.input_source.inputs_count_estimated\n- metrics.work.inputs_count_estimated\n- metrics.work.inputs_percent_estimated\n- metrics.review.inputs_count_estimated\n- metrics.review.inputs_count_estimated_per_reviewer\n- metrics.review.inputs_percent_estimated\n- metrics.review.inputs_percent_estimated_per_reviewer\n- metrics.review.inputs_reviewable_count_estimated_per_reviewer" }, { "name": "ids", "value": "", "type": "query", "description": "(optional) task IDs to filter on" }, { "name": "input_source_type", "value": "", "type": "query", "description": "(optional) input source type to filter\n\n - ALL_INPUTS: Use all inputs in the app.\n - SAVED_SEARCH: Use the inputs from a saved search.\n - DATASET: Inputs from a dataset.\n - INPUT: Single input (e.g. video livestream input)" }, { "name": "input_source_ids", "value": "", "type": "query", "description": "(optional) ids of input source to be filtered" } ] }, "docs": "List tasks from an app." }, { "info": { "name": "Add tasks to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add tasks to an app." }, { "info": { "name": "Patch one or more tasks.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more tasks." }, { "info": { "name": "Delete multiple tasks in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple tasks in one request." }, { "info": { "name": "Get a specific task from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks/:task_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response.\nCurrently supported additional fields:\n- all\n- worker.users\n- review.users\n- metrics.input_source.inputs_count_estimated\n- metrics.work.inputs_count_estimated\n- metrics.work.inputs_percent_estimated\n- metrics.review.inputs_count_estimated\n- metrics.review.inputs_count_estimated_per_reviewer\n- metrics.review.inputs_percent_estimated\n- metrics.review.inputs_percent_estimated_per_reviewer\n- metrics.review.inputs_reviewable_count_estimated_per_reviewer" } ] }, "docs": "Get a specific task from an app." }, { "info": { "name": "Task annotation count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks/:task_id/annotations/count", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path", "description": "task_id for which count per user per status is needed" }, { "name": "user_ids", "value": "", "type": "query", "description": "Only return counts for these user IDs, effectively operating as an\nOR among them to filter down the results.\nIf model_version_ids or workflow_version_ids are also provided, these user_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Only return counts for these model version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or workflow_version_ids are also provided, these model_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "Only return counts for these workflow version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or model_version_ids are also provided, these workflow_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." } ] }, "docs": "Task annotation count" }, { "info": { "name": "Deprecated: Use PutTaskAssignments with action=LABEL_START.\n This endpoint has initially been designed as a GET request,\n but has been re-designed to serve a PUT logic.\n In order to clearly highlight that this endpoint serves a PUT request,\n this endpoint has been deprecated and replaced by PutTaskAssignments with action=LABEL_START.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks/:task_id/assignments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path" } ] }, "docs": "Deprecated: Use PutTaskAssignments with action=LABEL_START.\n This endpoint has initially been designed as a GET request,\n but has been re-designed to serve a PUT logic.\n In order to clearly highlight that this endpoint serves a PUT request,\n this endpoint has been deprecated and replaced by PutTaskAssignments with action=LABEL_START." }, { "info": { "name": "PutTaskAssignments performs an idempotent action for the task assignments in given task.\nSee PutTaskAssignmentsRequestAction for more details about possible actions.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks/:task_id/assignments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path" } ] }, "docs": "PutTaskAssignments performs an idempotent action for the task assignments in given task.\nSee PutTaskAssignmentsRequestAction for more details about possible actions." }, { "info": { "name": "Task Input count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks/:task_id/inputs/count", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path", "description": "task_id for which count per user per status is needed" }, { "name": "user_ids", "value": "", "type": "query", "description": "Only return counts for these user IDs, effectively operating as an\nOR among them to filter down the results.\nIf model_version_ids or workflow_version_ids are also provided, these user_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Only return counts for these model version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or workflow_version_ids are also provided, these model_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "Only return counts for these workflow version IDs, effectively operating as an\nOR among them to filter down the results.\nIf user_ids or model_version_ids are also provided, these workflow_version_ids are OR'd with them as well because\nwe want the union of all worker (user, model or workflow) counts in the results." } ] }, "docs": "Task Input count" }, { "info": { "name": "V2_GetInputSamples", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/tasks/:task_id/inputs/samples", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "path" }, { "name": "user_ids", "value": "", "type": "query", "description": "URL param. If zero ids provided, returns for all task labelers" } ] } }, { "info": { "name": "V2_ListUploads", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/uploads", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "PostUploads is used to upload files. Note that this does not create inputs.\nreturns job with uploadID, job has UPLOAD_IN_PROGRESS status\nActual upload content can be done in multiple calls with PutUploadContentParts\nYou can get status of upload with GetUpload or ListUploads endpoints\nSee also PostInputsUploads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/uploads", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "PostUploads is used to upload files. Note that this does not create inputs.\nreturns job with uploadID, job has UPLOAD_IN_PROGRESS status\nActual upload content can be done in multiple calls with PutUploadContentParts\nYou can get status of upload with GetUpload or ListUploads endpoints\nSee also PostInputsUploads" }, { "info": { "name": "V2_DeleteUploads", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/uploads", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_GetUpload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/uploads/:upload_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "upload_id", "value": "", "type": "path", "description": "Upload ID" } ] } }, { "info": { "name": "Upload a part of a multipart upload.\nBehaviour on completion depends on the endpoint that was used to initiate the upload.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/uploads/:upload_id/content_parts", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "upload_id", "value": "", "type": "path" } ] }, "docs": "Upload a part of a multipart upload.\nBehaviour on completion depends on the endpoint that was used to initiate the upload." }, { "info": { "name": "List all the workflows.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the name" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the workflow" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "featured_only", "value": "", "type": "query", "description": "Filtering options:\nIf true, we only return workflows that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return workflows that are starred by the requesting user" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter workflows by bookmark. If set, only return bookmarked workflows. Otherwise none bookmarked workflows only." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the workflow:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query various text fields (id, description and notes) that can contain the words in the query string.\nDeprecated: use search instead." }, { "name": "id", "value": "", "type": "query", "description": "Filter by the id of the workflow. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "search_term", "value": "", "type": "query", "description": "Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added\nDeprecated: use search instead." } ] }, "docs": "List all the workflows." }, { "info": { "name": "Add a workflow to an app.\nNote(zeiler): the order of the workflows that are returned from this endpoint\nmay be different than the order in which the user provides them. This is because\nwe reorder by a sort that optimizes for performance of the graph and its dependencies.\nWhen using the workflow in any future call the order returned by this endpoint\nwill be used.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Add a workflow to an app.\nNote(zeiler): the order of the workflows that are returned from this endpoint\nmay be different than the order in which the user provides them. This is because\nwe reorder by a sort that optimizes for performance of the graph and its dependencies.\nWhen using the workflow in any future call the order returned by this endpoint\nwill be used." }, { "info": { "name": "Patch one or more workflows.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more workflows." }, { "info": { "name": "Delete multiple workflows in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple workflows in one request." }, { "info": { "name": "Patch one or more workflows ids.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/ids", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" } ] }, "docs": "Patch one or more workflows ids." }, { "info": { "name": "Get a specific workflow from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "Workflow ID to retrieve\nIf no ID is specified we return default workflow of the application\nIf an ID is specified by default we first looks into Clarifai workflows for a Workflow ID" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars" } ] }, "docs": "Get a specific workflow from an app." }, { "info": { "name": "Delete a single workflow.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" } ] }, "docs": "Delete a single workflow." }, { "info": { "name": "V2_PostWorkflowVersionsPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/publish", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" } ] } }, { "info": { "name": "Predict using a workflow.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/results", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "Workflow ID to retrieve\nIf no ID is specified we return default workflow of the application\nIf an ID is specified by default we first looks into Clarifai workflows for a Workflow ID" } ] }, "docs": "Predict using a workflow." }, { "info": { "name": "V2_PostWorkflowVersionsUnPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/unpublish", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" } ] } }, { "info": { "name": "List workflow versions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "List versions for the workflow identified by this id" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List workflow versions." }, { "info": { "name": "Patch workflow versions.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "The id of the workflow that has the requested versions to patch." } ] }, "docs": "Patch workflow versions." }, { "info": { "name": "Delete workflow versions.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "The id of the workflow that has the requested versions to delete." } ] }, "docs": "Delete workflow versions." }, { "info": { "name": "Predict using a workflow.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:version_id/results", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "Workflow ID to retrieve\nIf no ID is specified we return default workflow of the application\nIf an ID is specified by default we first looks into Clarifai workflows for a Workflow ID" }, { "name": "version_id", "value": "", "type": "path", "description": "Workflow version ID to retrieve\nIf no ID is specified, latest workflow version is used" } ] }, "docs": "Predict using a workflow." }, { "info": { "name": "Get single workflow version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path", "description": "The id of the workflow that has the requested version." }, { "name": "workflow_version_id", "value": "", "type": "path", "description": "Get the identified by this id" } ] }, "docs": "Get single workflow version." }, { "info": { "name": "V2_ListWorkflowVersionEvaluations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" }, { "name": "workflow_version_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostWorkflowVersionEvaluations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" }, { "name": "workflow_version_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_PatchWorkflowVersionEvaluations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" }, { "name": "workflow_version_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_GetWorkflowVersionEvaluation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id/evaluations/:workflow_version_evaluation_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" }, { "name": "workflow_version_id", "value": "", "type": "path" }, { "name": "workflow_version_evaluation_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_ListWorkflowVersionEvaluationData", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id/evaluations/:workflow_version_evaluation_id/data", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" }, { "name": "workflow_version_id", "value": "", "type": "path" }, { "name": "workflow_version_evaluation_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostWorkflowVersionEvaluationData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/apps/:user_app_id.app_id/workflows/:workflow_id/versions/:workflow_version_id/evaluations/:workflow_version_evaluation_id/data", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" }, { "name": "workflow_version_id", "value": "", "type": "path" }, { "name": "workflow_version_evaluation_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_PostAuditLogSearches", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/audit_log/searches", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "Collaboration includes the app user are invitied to work on", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/collaborations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "template_only", "value": "", "type": "query", "description": "Filtering options:\nIf true, we only return collaborations on apps that are marked as a template by the app owner." } ] }, "docs": "Collaboration includes the app user are invitied to work on" }, { "info": { "name": "V2_ListComputeClusters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostComputeClusters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "V2_PatchComputeClusters", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "Delete multiple compute_clusters in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Delete multiple compute_clusters in one request." }, { "info": { "name": "ComputeCluster CRUD", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "ComputeCluster CRUD" }, { "info": { "name": "V2_ListNodepools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "active_usage", "value": "", "type": "query", "description": "Only return nodepools that are actively being used (having runners with\nreplicas >= threshold and pipeline versions scheduled to run)" } ] } }, { "info": { "name": "V2_PostNodepools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" } ] } }, { "info": { "name": "V2_PatchNodepools", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" } ] } }, { "info": { "name": "Delete multiple nodepools in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple nodepools in one request." }, { "info": { "name": "Nodepools CRUD", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "active_usage", "value": "", "type": "query", "description": "Only return the nodepool if it is actively being used (having min_instances > 0,\nrunners with replicas >= threshold or pipeline versions scheduled to run)" } ] }, "docs": "Nodepools CRUD" }, { "info": { "name": "putting above the Get Nodepool endpoint to make it appear above the other one", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/pipeline_version_runs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path", "description": "compute cluster id" }, { "name": "nodepool_id", "value": "", "type": "path", "description": "nodepool id" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "pipeline_id", "value": "", "type": "query", "description": "The ID of the pipeline" }, { "name": "pipeline_version_id", "value": "", "type": "query", "description": "The ID of the pipeline version" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "status_codes", "value": "", "type": "query", "description": "Filter based on status\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" } ] }, "docs": "putting above the Get Nodepool endpoint to make it appear above the other one" }, { "info": { "name": "List all the runners for the user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "min_replicas", "value": "", "type": "query", "description": "Only return runners whose replicas are >= min_replicas." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "(optional URL parameter) ModelVersion IDs. To list all runners for the model version" } ] }, "docs": "List all the runners for the user." }, { "info": { "name": "Add a runners to a user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" } ] }, "docs": "Add a runners to a user." }, { "info": { "name": "Delete multiple runners in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" } ] }, "docs": "Delete multiple runners in one request." }, { "info": { "name": "Get a specific runner.\nTODO(zeiler): runner_id is a UUID so can list globally as well.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners/:runner_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "runner_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific runner.\nTODO(zeiler): runner_id is a UUID so can list globally as well." }, { "info": { "name": "List items for the remote runner to work on.\nsince the runner_id is a UUID we can access it directly too.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners/:runner_id/items", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "runner_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "List items for the remote runner to work on.\nsince the runner_id is a UUID we can access it directly too." }, { "info": { "name": "Post back outputs from remote runners\nsince the runner_id is a UUID we can access it directly too.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners/:runner_id/items/:runner_item_id/outputs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path", "description": "The particular nodepool that runner belongs to" }, { "name": "runner_id", "value": "", "type": "path", "description": "The particular runner that processed the work." }, { "name": "runner_item_id", "value": "", "type": "path", "description": "The particular item of work processed." } ] }, "docs": "Post back outputs from remote runners\nsince the runner_id is a UUID we can access it directly too." }, { "info": { "name": "V2_ListLogEntries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/runners/:runner_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "runner_id", "value": "", "type": "path" }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run]" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to last page." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 32." }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "model_id", "value": "", "type": "query", "description": "The Model ID, if a model produced the logs." }, { "name": "model_version_id", "value": "", "type": "query", "description": "The Version ID, if a model version produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "compute_cluster_user_id", "value": "", "type": "query", "description": "Where the logs came from." }, { "name": "pipeline_id", "value": "", "type": "query", "description": "Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "query" }, { "name": "pipeline_version_run_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "Update nodepool status. Called by the agent to report nodepool health/errors.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/nodepools/:nodepool_id/status", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" } ] }, "docs": "Update nodepool status. Called by the agent to report nodepool health/errors." }, { "info": { "name": "V2_ListLogEntries3", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run]" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to last page." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 32." }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "model_id", "value": "", "type": "query", "description": "The Model ID, if a model produced the logs." }, { "name": "model_version_id", "value": "", "type": "query", "description": "The Version ID, if a model version produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "compute_cluster_user_id", "value": "", "type": "query", "description": "Where the logs came from." }, { "name": "nodepool_id", "value": "", "type": "query" }, { "name": "runner_id", "value": "", "type": "query" }, { "name": "pipeline_id", "value": "", "type": "query", "description": "Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "query" }, { "name": "pipeline_version_run_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_ListLogEntries2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/compute_clusters/:compute_cluster_user_id/:compute_cluster_id/nodepools/:nodepool_id/versions/:model_version_id/:log_type/logs", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "compute_cluster_user_id", "value": "", "type": "path", "description": "Where the logs came from." }, { "name": "compute_cluster_id", "value": "", "type": "path" }, { "name": "nodepool_id", "value": "", "type": "path" }, { "name": "model_version_id", "value": "", "type": "path", "description": "The Version ID, if a model version produced the logs." }, { "name": "log_type", "value": "", "type": "path", "description": "The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run]" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to last page." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 32." }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "model_id", "value": "", "type": "query", "description": "The Model ID, if a model produced the logs." }, { "name": "workflow_id", "value": "", "type": "query", "description": "Workflow Id, if a workflow produced the logs." }, { "name": "runner_id", "value": "", "type": "query" }, { "name": "pipeline_id", "value": "", "type": "query", "description": "Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run\nMust include user_app_id with user_id and app_id as well." }, { "name": "pipeline_version_id", "value": "", "type": "query" }, { "name": "pipeline_version_run_id", "value": "", "type": "query" }, { "name": "pipeline_step_id", "value": "", "type": "query", "description": "During pipeline step build provide these IDs." }, { "name": "pipeline_step_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "List all the datasets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/datasets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the app" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "If neither sort option is set to true, will sort by modified_at." }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the external id" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "starred_only", "value": "", "type": "query", "description": "Filtering options:" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter datasets by bookmark. If set, only return bookmarked datasets. Otherwise none bookmarked datasets only." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the dataset:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "id", "value": "", "type": "query", "description": "Fuzzy filter on dataset ID\nDeprecated: use search instead." } ] }, "docs": "List all the datasets." }, { "info": { "name": "V2_ListDeployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/deployments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query", "description": "(optional URL parameter) Nodepool ID. To list all deployed workers in a Nodepool" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "(optional URL parameter) ModelVersion IDs. To list all deployments for the model version" }, { "name": "workflow_version_ids", "value": "", "type": "query", "description": "(optional URL parameter) WorkflowVersion IDs. To list all deployments for the workflow version" }, { "name": "compute_cluster_id", "value": "", "type": "query", "description": "(optional URL parameter) ComputeCluster ID. To list all deployed workers in a ComputeCluster" }, { "name": "scheduling_priorities", "value": "", "type": "query", "description": "(optional URL parameter) Scheduling priorities. To list all deployments with one of the\nprovided scheduling priorities. Valid values are 0-9." } ] } }, { "info": { "name": "V2_PostDeployments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/deployments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "V2_PatchDeployments", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/deployments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "Delete multiple deployments in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/deployments", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Delete multiple deployments in one request." }, { "info": { "name": "Deployments CRUD", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/deployments/:deployment_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "deployment_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Deployments CRUD" }, { "info": { "name": "Deprecated: App duplication is no longer supported.\nListAppDuplications lists all app duplication jobs created by the user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/duplications", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "Deprecated: App duplication is no longer supported.\nListAppDuplications lists all app duplication jobs created by the user." }, { "info": { "name": "Deprecated: App duplication is no longer supported.\nGetAppDuplication returns an app duplication job created by the user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/duplications/:app_duplication_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "app_duplication_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Deprecated: App duplication is no longer supported.\nGetAppDuplication returns an app duplication job created by the user." }, { "info": { "name": "V2_ListEvaluations2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "If true, sort in ascending order, otherwise sort in descending order." }, { "name": "sort_by_app_id", "value": "", "type": "query", "description": "Whether to order by application id" }, { "name": "sort_by_roc_auc", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_roc_auc" }, { "name": "sort_by_f1", "value": "", "type": "query", "description": "Whether to order by eval metric summary.f1" }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by when the metric was created" }, { "name": "sort_by_mean_avg_precision", "value": "", "type": "query", "description": "Whether to order by eval metric summary.mean_avg_precision_iou_50" }, { "name": "sort_by_precision", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_precision" }, { "name": "sort_by_recall", "value": "", "type": "query", "description": "Whether to order by eval metric summary.macro_avg_recall" }, { "name": "sort_by_model_id", "value": "", "type": "query" }, { "name": "sort_by_eval_dataset_id", "value": "", "type": "query" }, { "name": "sort_by_train_dataset_id", "value": "", "type": "query" }, { "name": "model_type_id", "value": "", "type": "query", "description": "Filter on model type id" }, { "name": "eval_dataset_ids", "value": "", "type": "query", "description": "Filter on dataset ID of the dataset version specified in the metric version" }, { "name": "train_dataset_ids", "value": "", "type": "query", "description": "Filter on dataset ID of the dataset version specified by the model version" }, { "name": "concept_ids", "value": "", "type": "query", "description": "Filter on concept IDs specified in the modele version's output_info" }, { "name": "show_failed_metrics", "value": "", "type": "query", "description": "Whether to show failed metrics, defaults to false" } ] } }, { "info": { "name": "List all the keys.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/keys", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "not_expired", "value": "", "type": "query", "description": "Filtering options:\nIf true, only return keys that have not expired." }, { "name": "scopes", "value": "", "type": "query", "description": "Only return keys that have the listed scopes." }, { "name": "endpoints", "value": "", "type": "query", "description": "Only return keys that have the listed endpoints." }, { "name": "type", "value": "", "type": "query", "description": "Only return keys with the listed type." } ] }, "docs": "List all the keys." }, { "info": { "name": "Add a key to an app.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/keys", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Add a key to an app." }, { "info": { "name": "Patch one or more keys.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/keys", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Patch one or more keys." }, { "info": { "name": "Get a specific key from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/keys/:key_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "key_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get a specific key from an app." }, { "info": { "name": "Search over the keys to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/keys/:key_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "key_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Search over the keys to find one or more you're looking for.\nThis leverage the \"body\" parameter because we also have page and\nper_page as url query param variables in this request." }, { "info": { "name": "V2_PostMetricsQuery", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/metrics", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "V2_ListMetricLabels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/metrics/labels", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "metric_types", "value": "", "type": "query", "description": " - MODEL_TTFT: Model metrics: 1-50\n - NODEPOOL_NODE_COUNT: Nodepool metrics: 51-100" } ] } }, { "info": { "name": "List all the models.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/models", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets, counts" }, { "name": "show_replicas", "value": "", "type": "query", "description": "If true, show replica counts for models." }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_name", "value": "", "type": "query", "description": "Whether to order by the name" }, { "name": "sort_by_num_inputs", "value": "", "type": "query", "description": "Whether to order by the number of training inputs" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time of the latest model version.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at" }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by count of stars" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "model_type_id", "value": "", "type": "query", "description": "Filtering options:\nFilter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id's\nsupported." }, { "name": "trained_only", "value": "", "type": "query", "description": "If true, we only return models that have the status MODEL_TRAINED, which includes non-trainable model types." }, { "name": "input_fields", "value": "", "type": "query", "description": "The list of input fields to the model.\nFor example, you can specify 'image', which will return models that make inferences on images like visual-classifier models." }, { "name": "output_fields", "value": "", "type": "query", "description": "The list of output fields to the model.\nFor example, you can specify 'regions[...].data.concepts', which will return visual-detector models." }, { "name": "license", "value": "", "type": "query", "description": "Filter by the license of the model version" }, { "name": "featured_only", "value": "", "type": "query", "description": "If true, we only return models that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return models that are starred by the requesting user" }, { "name": "toolkits", "value": "", "type": "query", "description": "List of toolkit tags to filter by" }, { "name": "use_cases", "value": "", "type": "query", "description": "List of use_case tags to filter by" }, { "name": "languages", "value": "", "type": "query", "description": "List of language tags to filter by" }, { "name": "dont_fetch_from_main", "value": "", "type": "query", "description": "Old API behavior resulted in returning clarifai main models when calling ListModels while scoped to an app. While we transition\naway from that, we can use this flag to not always fetch clarifai main models, unless that is the app we are explicitly listing for.\n\n@exclude TODO (EAGLE-4447): Remove this field" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter models by bookmark. If set, only return bookmarked models. Otherwise none bookmarked models only.\nNote: you can not filter `trained_only` and bookmark at the same time.\nWhen filter by bookmark, we will return trained and untrained models." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "Filter by the model version ids. If set, only return the model of these versions." }, { "name": "license_type", "value": "", "type": "query", "description": "Filter by LicenseType" }, { "name": "source", "value": "", "type": "query", "description": "Filter by Source" }, { "name": "creator", "value": "", "type": "query", "description": "Filter by Creator" }, { "name": "min_replicas", "value": "", "type": "query", "description": "Filter by model versions runners with replicas >= min_replicas." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the model:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query name, description and id fields, that can contain the words in the query string. Does NOT support wildcards - full words only. Supports operators \"OR\" and \"-\" as NOT.\nDeprecated: use search instead." }, { "name": "name", "value": "", "type": "query", "description": "Filter by the description and id of the model. This supports wildcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "filter_by_user_id", "value": "", "type": "query", "description": "Extends the name filter to include the user_id of the application owner that the model belongs to.\nDeprecated: use search instead of name." } ] }, "docs": "List all the models." }, { "info": { "name": "V2_MyScopesUser", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/myscopes", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_ListNodepools2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/nodepools", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "compute_cluster_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "active_usage", "value": "", "type": "query", "description": "Only return nodepools that are actively being used (having runners with\nreplicas >= threshold and pipeline versions scheduled to run)" } ] } }, { "info": { "name": "List all the runners for the user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/runners", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "compute_cluster_id", "value": "", "type": "query" }, { "name": "min_replicas", "value": "", "type": "query", "description": "Only return runners whose replicas are >= min_replicas." }, { "name": "model_version_ids", "value": "", "type": "query", "description": "(optional URL parameter) ModelVersion IDs. To list all runners for the model version" } ] }, "docs": "List all the runners for the user." }, { "info": { "name": "Get a specific runner.\nTODO(zeiler): runner_id is a UUID so can list globally as well.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/runners/:runner_id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "runner_id", "value": "", "type": "path" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "nodepool_id", "value": "", "type": "query" }, { "name": "compute_cluster_id", "value": "", "type": "query" } ] }, "docs": "Get a specific runner.\nTODO(zeiler): runner_id is a UUID so can list globally as well." }, { "info": { "name": "List all auth scopes available to me as a user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/scopes", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "key_type", "value": "", "type": "query", "description": "If \"personal_access_token\" include scopes and endpoints available to personal access tokens.\nIf \"app_specific_key\" include scopes and endpoints available to app-specific keys. (default)" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "List all auth scopes available to me as a user." }, { "info": { "name": "V2_ListSecrets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/secrets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostSecrets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/secrets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "V2_PatchSecrets", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/secrets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "V2_DeleteSecrets", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/secrets", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] } }, { "info": { "name": "V2_GetSecret", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/secrets/:id", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "id", "value": "", "type": "path", "description": "The id of the secret to get" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] } }, { "info": { "name": "Validate new password in real-time for a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/validate_password", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" } ] }, "docs": "Validate new password in real-time for a user" }, { "info": { "name": "List all the workflows.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/users/:user_app_id.user_id/workflows", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "path", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the name" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the workflow" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "featured_only", "value": "", "type": "query", "description": "Filtering options:\nIf true, we only return workflows that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return workflows that are starred by the requesting user" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter workflows by bookmark. If set, only return bookmarked workflows. Otherwise none bookmarked workflows only." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the workflow:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query various text fields (id, description and notes) that can contain the words in the query string.\nDeprecated: use search instead." }, { "name": "id", "value": "", "type": "query", "description": "Filter by the id of the workflow. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "search_term", "value": "", "type": "query", "description": "Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added\nDeprecated: use search instead." } ] }, "docs": "List all the workflows." }, { "info": { "name": "Validate new password in real-time for a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/validate_password" }, "docs": "Validate new password in real-time for a user" }, { "info": { "name": "V2_ListWorkflowEvaluationTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflow-version-evaluation-templates" } }, { "info": { "name": "V2_ListWorkflowVersionEvaluations2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflow-version-evaluations", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "workflow_id", "value": "", "type": "query" }, { "name": "workflow_version_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_GetWorkflowVersionEvaluation2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflow-version-evaluations/:workflow_version_evaluation_id", "params": [ { "name": "workflow_version_evaluation_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "workflow_id", "value": "", "type": "query" }, { "name": "workflow_version_id", "value": "", "type": "query" } ] } }, { "info": { "name": "V2_ListWorkflowVersionEvaluationData2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflow-version-evaluations/:workflow_version_evaluation_id/data", "params": [ { "name": "workflow_version_evaluation_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "workflow_id", "value": "", "type": "query" }, { "name": "workflow_version_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] } }, { "info": { "name": "V2_PostWorkflowVersionEvaluationData2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/workflow-version-evaluations/:workflow_version_evaluation_id/data", "params": [ { "name": "workflow_version_evaluation_id", "value": "", "type": "path" } ] } }, { "info": { "name": "List all the workflows.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflows", "params": [ { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars" }, { "name": "sort_ascending", "value": "", "type": "query", "description": "Sorting options:\nWhether to sort in ascending order. If false, will order in descending order." }, { "name": "sort_by_id", "value": "", "type": "query", "description": "Whether to order by the name" }, { "name": "sort_by_modified_at", "value": "", "type": "query", "description": "Whether to order by the modified_at time.\nIf none of the sort options is set to true, will sort by modified_at." }, { "name": "sort_by_created_at", "value": "", "type": "query", "description": "Whether to order by the created_at time." }, { "name": "sort_by_star_count", "value": "", "type": "query", "description": "Whether to order by the number of users stared the workflow" }, { "name": "sort_by_relevance", "value": "", "type": "query", "description": "Whether to order by search query relevance. Can only be used if search is not empty." }, { "name": "featured_only", "value": "", "type": "query", "description": "Filtering options:\nIf true, we only return workflows that are handpicked by clarifai staff" }, { "name": "starred_only", "value": "", "type": "query", "description": "If true, we only return workflows that are starred by the requesting user" }, { "name": "bookmark", "value": "", "type": "query", "description": "Filter workflows by bookmark. If set, only return bookmarked workflows. Otherwise none bookmarked workflows only." }, { "name": "visibility.gettable", "value": "", "type": "query", "description": " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." }, { "name": "search", "value": "", "type": "query", "description": "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the workflow:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." }, { "name": "query", "value": "", "type": "query", "description": "Query various text fields (id, description and notes) that can contain the words in the query string.\nDeprecated: use search instead." }, { "name": "id", "value": "", "type": "query", "description": "Filter by the id of the workflow. This supports wilcard queries like \"gen*\" to match \"general\" as an example.\nDeprecated: use search instead." }, { "name": "search_term", "value": "", "type": "query", "description": "Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added\nDeprecated: use search instead." } ] }, "docs": "List all the workflows." }, { "info": { "name": "Add a workflow to an app.\nNote(zeiler): the order of the workflows that are returned from this endpoint\nmay be different than the order in which the user provides them. This is because\nwe reorder by a sort that optimizes for performance of the graph and its dependencies.\nWhen using the workflow in any future call the order returned by this endpoint\nwill be used.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/workflows" }, "docs": "Add a workflow to an app.\nNote(zeiler): the order of the workflows that are returned from this endpoint\nmay be different than the order in which the user provides them. This is because\nwe reorder by a sort that optimizes for performance of the graph and its dependencies.\nWhen using the workflow in any future call the order returned by this endpoint\nwill be used." }, { "info": { "name": "Patch one or more workflows.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/workflows" }, "docs": "Patch one or more workflows." }, { "info": { "name": "Delete multiple workflows in one request.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/workflows" }, "docs": "Delete multiple workflows in one request." }, { "info": { "name": "Get a specific workflow from an app.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "Workflow ID to retrieve\nIf no ID is specified we return default workflow of the application\nIf an ID is specified by default we first looks into Clarifai workflows for a Workflow ID" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "additional_fields", "value": "", "type": "query", "description": "(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars" } ] }, "docs": "Get a specific workflow from an app." }, { "info": { "name": "Delete a single workflow.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Delete a single workflow." }, { "info": { "name": "V2_PostWorkflowVersionsPublish2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/workflows/:workflow_id/publish", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ] } }, { "info": { "name": "Predict using a workflow.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/workflows/:workflow_id/results", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "Workflow ID to retrieve\nIf no ID is specified we return default workflow of the application\nIf an ID is specified by default we first looks into Clarifai workflows for a Workflow ID" } ] }, "docs": "Predict using a workflow." }, { "info": { "name": "V2_PostWorkflowVersionsUnPublish2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/workflows/:workflow_id/unpublish", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ] } }, { "info": { "name": "List workflow versions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflows/:workflow_id/versions", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "List versions for the workflow identified by this id" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks.\nDefaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "(optional URL parameter) The number of results that will be contained in each page. Defaults\nto 128." } ] }, "docs": "List workflow versions." }, { "info": { "name": "Patch workflow versions.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/workflows/:workflow_id/versions", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The id of the workflow that has the requested versions to patch." } ] }, "docs": "Patch workflow versions." }, { "info": { "name": "Delete workflow versions.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/workflows/:workflow_id/versions", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The id of the workflow that has the requested versions to delete." } ] }, "docs": "Delete workflow versions." }, { "info": { "name": "Get single workflow version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/workflows/:workflow_id/versions/:workflow_version_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The id of the workflow that has the requested version." }, { "name": "workflow_version_id", "value": "", "type": "path", "description": "Get the identified by this id" }, { "name": "user_app_id.user_id", "value": "", "type": "query", "description": "Note user_id 'me' is reserved - it is the alias for the id of authorized user" }, { "name": "user_app_id.app_id", "value": "", "type": "query" } ] }, "docs": "Get single workflow version." } ] } ], "bundled": true }