{ "opencollection": "1.0.0", "info": { "name": "Fireworks AI Anthropic Compatible Messages anthropic-messages.openapi_other gateway.openapi_Gateway API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "gateway.openapi_Gateway", "type": "folder" }, "items": [ { "info": { "name": "List Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of accounts to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListAccounts call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListAccounts must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only accounts satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "Not supported.\nAccounts will be returned ordered by `name`." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Accounts" }, { "info": { "name": "Refresh a session JWT before expiry with a fresh TTL.", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/auth/refresh", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Refresh a session JWT before expiry with a fresh TTL." }, { "info": { "name": "APIs for credit codes.\nRedeem Credit Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/creditCodes:redeem", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "APIs for credit codes.\nRedeem Credit Code" }, { "info": { "name": "Validate Model Config", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/validateModelConfig", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate Model Config" }, { "info": { "name": "Get Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Account" }, { "info": { "name": "Distinct filter values for an account/time range (serverless + dedicated; for FE, separate -yet mirrors GetAccountUsage).", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/accountUsageFilterOptions", "params": [ { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" }, { "name": "usageType", "value": "", "type": "query", "description": "If not specified, loads filter options for both usage streams.\n\n - SERVERLESS: Serverless filter dimensions only (model_name, api_key_id, annotations.*).\n - DEDICATED_DEPLOYMENT: Dedicated deployment filter dimensions (deployment_name, annotations.team, .project, .environment)." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Distinct filter values for an account/time range (serverless + dedicated; for FE, separate -yet mirrors GetAccountUsage)." }, { "info": { "name": "List User Audit Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/auditLogs", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Start time of the audit logs to retrieve.\nIf unspecified, the default is 30 days before now." }, { "name": "endTime", "value": "", "type": "query", "description": "End time of the audit logs to retrieve.\nIf unspecified, the default is the current time." }, { "name": "email", "value": "", "type": "query", "description": "Optional.\nFilter audit logs for user email associated with the account." }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of audit logs to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 10." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListAuditLogs call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListAuditLogs must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Unused but required to use existing ListRequest functionality." }, { "name": "orderBy", "value": "", "type": "query", "description": "Unused but required to use existing ListRequest functionality." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List User Audit Logs" }, { "info": { "name": "List Batch Inference Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/batchInferenceJobs", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of batch inference jobs to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListBatchInferenceJobs call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListBatchInferenceJobs must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only jobs satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"created_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Batch Inference Jobs" }, { "info": { "name": "Create Batch Inference Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/batchInferenceJobs", "params": [ { "name": "batchInferenceJobId", "value": "", "type": "query", "description": "ID of the batch inference job." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Batch Inference Job" }, { "info": { "name": "Get Batch Inference Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/batchInferenceJobs/:batch_inference_job_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "batch_inference_job_id", "value": "", "type": "path", "description": "The Batch Inference Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Batch Inference Job" }, { "info": { "name": "Delete Batch Inference Job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/batchInferenceJobs/:batch_inference_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "batch_inference_job_id", "value": "", "type": "path", "description": "The Batch Inference Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Batch Inference Job" }, { "info": { "name": "Get billing summary information for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/billing/summary", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Start time for the billing period.\nNote: Costs are aggregated daily. Only the date portion (YYYY-MM-DD) is used;\nthe time portion is ignored. For example, 2025-10-05T07:18:29Z and\n2025-10-05T23:59:59Z are treated the same as 2025-10-05T00:00:00Z." }, { "name": "endTime", "value": "", "type": "query", "description": "End time for the billing period (exclusive).\nNote: Costs are aggregated daily. Only the date portion (YYYY-MM-DD) is used;\nthe time portion is ignored. Costs for the end date are NOT included.\nFor example, to get costs for Oct 5 and Oct 6, use:\n start_time: 2025-10-05T00:00:00Z\n end_time: 2025-10-07T00:00:00Z (Oct 7 is excluded)" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get billing summary information for an account" }, { "info": { "name": "Get account usage (serverless and dedicated deployments).\nOptionally filter by usage type via the usage_type field. If not specified, returns all usage types.\nTODO: rename this to /accountUsage", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/billingUsage", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Costs returned are inclusive of `start_time`.\nstart_time must be before end_time." }, { "name": "endTime", "value": "", "type": "query", "description": "Costs returned are exclusive of `end_time`.\nend_time must not be more than 31 days after start_time." }, { "name": "usageType", "value": "", "type": "query", "description": "Usage type to query usage for\nIf not specified, returns all usage types (both serverless and dedicated deployments).\n\n - USAGE_TYPE_UNSPECIFIED: Default value. When specified (or when usage_type field is not set),\nreturns usage data for all deployment types: both serverless requests and dedicated deployments.\n - SERVERLESS: Returns only serverless usage data.\nFilters the response to include only usage from serverless API requests.\n - DEDICATED_DEPLOYMENT: Returns only dedicated deployment usage data.\nFilters the response to include only usage from dedicated deployments." }, { "name": "timezone", "value": "", "type": "query", "description": "IANA timezone identifier for daily aggregation (e.g., \"America/Los_Angeles\", \"Europe/London\").\nWhen specified, the returned data will be aggregated into daily buckets based on this timezone.\nIf not specified or empty, defaults to \"UTC\".\nSee: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" }, { "name": "groupBy", "value": "", "type": "query", "description": "Dimension to group usage by (at most one value; repeated for wire compatibility).\nServerless: \"model_name\", \"api_key_id\", \"annotations.team\", \"annotations.project\", \"annotations.environment\".\nDedicated: \"deployment_name\", \"accelerator_type\", and the same annotation keys.\nWhen usage_type is unspecified, dimensions that apply only to the other stream are ignored there\n(e.g. \"deployment_name\" and \"accelerator_type\" are ignored for serverless; \"model_name\" and \"api_key_id\" for dedicated).\nExample: [\"annotations.team\"] or [\"model_name\"].\nIf empty: serverless aggregates by model name; dedicated defaults to deployment and accelerator type." }, { "name": "filter", "value": "", "type": "query", "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get account usage (serverless and dedicated deployments).\nOptionally filter by usage type via the usage_type field. If not specified, returns all usage types.\nTODO: rename this to /accountUsage" }, { "info": { "name": "Promote a checkpoint to a model.\nThe checkpoint is identified by account + snapshot ID; the trainer job ID\nis passed in the request body to resolve the GCS bucket.", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/checkpoints/:checkpoint_id:promote", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "checkpoint_id", "value": "", "type": "path", "description": "The Checkpoint Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Promote a checkpoint to a model.\nThe checkpoint is identified by account + snapshot ID; the trainer job ID\nis passed in the request body to resolve the GCS bucket." }, { "info": { "name": "List Clusters", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/clusters", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of clusters to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListClusters call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListClusters must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only clusters satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Clusters" }, { "info": { "name": "Create Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/clusters", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Cluster" }, { "info": { "name": "Get Cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/clusters/:cluster_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The Cluster Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Cluster" }, { "info": { "name": "Update Cluster", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/clusters/:cluster_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The Cluster Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Cluster" }, { "info": { "name": "Delete Cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/clusters/:cluster_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The Cluster Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Cluster" }, { "info": { "name": "Get Cluster Connection Info", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/clusters/:cluster_id:getConnectionInfo", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The Cluster Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve connection settings for the cluster to be put in kubeconfig" }, { "info": { "name": "List Credit Redemptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/creditRedemptions", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of redemptions to return" }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListCreditRedemptions call" }, { "name": "filter", "value": "", "type": "query", "description": "Filter string to filter redemptions" }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Credit Redemptions" }, { "info": { "name": "List Datasets", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of datasets to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDatasets call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDatasets must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only model satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Datasets" }, { "info": { "name": "Create Dataset", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Dataset" }, { "info": { "name": "Get Dataset", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Dataset" }, { "info": { "name": "Update Dataset", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Dataset" }, { "info": { "name": "Delete Dataset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Dataset" }, { "info": { "name": "Get Dataset Download Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id:getDownloadEndpoint", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "downloadLineage", "value": "", "type": "query", "description": "If true, downloads entire lineage chain (all related datasets).\nFilenames will be prefixed with dataset IDs to avoid collisions." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Dataset Download Endpoint" }, { "info": { "name": "Get Dataset Upload Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id:getUploadEndpoint", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Dataset Upload Endpoint" }, { "info": { "name": "Gateway_SplitDataset", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id:splitDataset", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Validate Dataset Upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/datasets/:dataset_id:validateUpload", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dataset_id", "value": "", "type": "path", "description": "The Dataset Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate Dataset Upload" }, { "info": { "name": "List LoRAs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployedModels", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of deployed models to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDeployedModels call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDeployedModels must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only depoyed models satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List LoRAs" }, { "info": { "name": "Load LoRA", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployedModels", "params": [ { "name": "replaceMergedAddon", "value": "", "type": "query", "description": "Merges new addon to the base model, while unmerging/deleting any existing addon in the deployment. Must be specified for hot reload deployments" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load LoRA" }, { "info": { "name": "Get LoRA", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployedModels/:deployed_model_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployed_model_id", "value": "", "type": "path", "description": "The Deployed Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get LoRA" }, { "info": { "name": "Update LoRA", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployedModels/:deployed_model_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployed_model_id", "value": "", "type": "path", "description": "The Deployed Model Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update LoRA" }, { "info": { "name": "Unload LoRA", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployedModels/:deployed_model_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployed_model_id", "value": "", "type": "path", "description": "The Deployed Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Unload LoRA" }, { "info": { "name": "List Deployment Shapes", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of deployments to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDeploymentShapes call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDeploymentShapes must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only deployment satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "targetModel", "value": "", "type": "query", "description": "Target model that the returned deployment shapes should be compatible with." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Deployment Shapes" }, { "info": { "name": "CRUD APIs for deployment shape.\nCreate Deployment Shape", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes", "params": [ { "name": "deploymentShapeId", "value": "", "type": "query", "description": "The ID of the deployment shape. If not specified, a random ID will be generated." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for deployment shape.\nCreate Deployment Shape" }, { "info": { "name": "Get Deployment Shape", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes/:deployment_shape_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "skipShapeValidation", "value": "", "type": "query", "description": "If true, returns the latest version regardless of validation status.\nBy default, returns the latest validated version." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_shape_id", "value": "", "type": "path", "description": "The Deployment Shape Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Deployment Shape" }, { "info": { "name": "Update Deployment Shape", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes/:deployment_shape_id", "params": [ { "name": "fromLatestValidated", "value": "", "type": "query", "description": "When true, the update will use the latest validated version snapshot as the base\nfor fields not present in the update mask; otherwise, the current shape is used." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_shape_id", "value": "", "type": "path", "description": "The Deployment Shape Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Deployment Shape" }, { "info": { "name": "Delete Deployment Shape", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes/:deployment_shape_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_shape_id", "value": "", "type": "path", "description": "The Deployment Shape Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Deployment Shape" }, { "info": { "name": "List Deployment Shapes Versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes/:deployment_shape_id/versions", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of deployment shape versions to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDeploymentShapeVersions call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDeploymentShapeVersions must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only deployment shape versions satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_shape_id", "value": "", "type": "path", "description": "The Deployment Shape Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Deployment Shapes Versions" }, { "info": { "name": "Get Deployment Shape Version", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes/:deployment_shape_id/versions/:version_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_shape_id", "value": "", "type": "path", "description": "The Deployment Shape Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Deployment Shape Version" }, { "info": { "name": "Update Deployment Shape Version", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deploymentShapes/:deployment_shape_id/versions/:version_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_shape_id", "value": "", "type": "path", "description": "The Deployment Shape Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Deployment Shape Version" }, { "info": { "name": "List Deployments", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of deployments to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDeployments call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDeployments must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only deployment satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "showDeleted", "value": "", "type": "query", "description": "If set, DELETED deployments will be included." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Deployments" }, { "info": { "name": "Create Deployment", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments", "params": [ { "name": "disableAutoDeploy", "value": "", "type": "query", "description": "By default, a deployment created with a currently undeployed base model\nwill be deployed to this deployment. If true, this auto-deploy function\nis disabled." }, { "name": "disableSpeculativeDecoding", "value": "", "type": "query", "description": "By default, a deployment will use the speculative decoding settings from\nthe base model. If true, this will disable speculative decoding." }, { "name": "deploymentId", "value": "", "type": "query", "description": "The ID of the deployment. If not specified, a random ID will be generated." }, { "name": "validateOnly", "value": "", "type": "query", "description": "If true, this will not create the deployment, but will return the deployment\nthat would be created." }, { "name": "skipShapeValidation", "value": "", "type": "query", "description": "By default, a deployment will ensure the deployment shape provided is validated.\nIf true, we will not require the deployment shape to be validated." }, { "name": "skipImageTagValidation", "value": "", "type": "query", "description": "If true, skip the image tag policy validation that blocks certain image tags.\nThis allows creating deployments with image tags that would otherwise be blocked." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Deployment" }, { "info": { "name": "Get Deployment", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Deployment" }, { "info": { "name": "Update Deployment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id", "params": [ { "name": "skipShapeValidation", "value": "", "type": "query", "description": "By default, updating a deployment shape will ensure the new deployment shape provided is validated.\nIf true, we will not require the deployment shape to be validated." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Deployment" }, { "info": { "name": "Delete Deployment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id", "params": [ { "name": "hard", "value": "", "type": "query", "description": "If true, this will perform a hard deletion." }, { "name": "ignoreChecks", "value": "", "type": "query", "description": "If true, this will ignore checks and force the deletion of a deployment that is currently\ndeployed and is in use." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Deployment" }, { "info": { "name": "Get ledger", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id/ledger", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get ledger" }, { "info": { "name": "Reset ledger for hot load", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id/ledger", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset ledger for hot load" }, { "info": { "name": "List Deployment Shards", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id/shards", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of deployment shards to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDeploymentShards call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDeploymentShards must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only deployment shard satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Deployment Shards" }, { "info": { "name": "Get termination message from deployment", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id/terminationMessage", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get termination message from deployment" }, { "info": { "name": "Get Deployment Metrics (Deprecated)", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id:metrics", "params": [ { "name": "timeRange", "value": "", "type": "query", "description": "The time range to fetch metrics for (e.g. \"1m\", \"10m\", \"2h\"). Defaults to 10m." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Deployment Metrics (Deprecated)" }, { "info": { "name": "Scale Deployment to a specific number of replicas or to zero", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id:scale", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Scale Deployment to a specific number of replicas or to zero" }, { "info": { "name": "Undelete Deployment", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/deployments/:deployment_id:undelete", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The Deployment Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Undelete Deployment" }, { "info": { "name": "List Developer Passes", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/developerPasses", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Maximum number of developer passes to return." }, { "name": "pageToken", "value": "", "type": "query", "description": "Page token from a previous ListDeveloperPasses call." }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression (e.g., \"state=ACTIVE\")" }, { "name": "orderBy", "value": "", "type": "query", "description": "Order by expression (e.g., \"create_time desc\")" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Developer Passes" }, { "info": { "name": "CRUD APIs for developer passes.\nCreate Developer Pass", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/developerPasses", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for developer passes.\nCreate Developer Pass" }, { "info": { "name": "Get Developer Pass", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/developerPasses/:developer_passe_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "developer_passe_id", "value": "", "type": "path", "description": "The Developer Passe Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Developer Pass" }, { "info": { "name": "Update Developer Pass", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/developerPasses/:developer_passe_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "developer_passe_id", "value": "", "type": "path", "description": "The Developer Passe Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Developer Pass" }, { "info": { "name": "Gateway_ListDpoJobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of dpo jobs to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListDpoJobs call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListDpoJobs must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria for the returned jobs. See https://google.aip.dev/160 for the filter syntax specification." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Gateway_CreateDpoJob", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs", "params": [ { "name": "dpoJobId", "value": "", "type": "query", "description": "ID of the DPO job, a random ID will be generated if not specified." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Gateway_GetDpoJob", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs/:dpo_job_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dpo_job_id", "value": "", "type": "path", "description": "The Dpo Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Gateway_DeleteDpoJob", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs/:dpo_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dpo_job_id", "value": "", "type": "path", "description": "The Dpo Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Cancel Dpo Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs/:dpo_job_id:cancel", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dpo_job_id", "value": "", "type": "path", "description": "The Dpo Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel Dpo Job" }, { "info": { "name": "Gateway_GetDpoJobMetricsFileEndpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs/:dpo_job_id:getMetricsFileEndpoint", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dpo_job_id", "value": "", "type": "path", "description": "The Dpo Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Resume Dpo Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/dpoJobs/:dpo_job_id:resume", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "dpo_job_id", "value": "", "type": "path", "description": "The Dpo Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume Dpo Job" }, { "info": { "name": "List Evaluation Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluationJobs", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Evaluation Jobs" }, { "info": { "name": "Create Evaluation Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluationJobs", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Evaluation Job" }, { "info": { "name": "Get Evaluation Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluationJobs/:evaluation_job_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluation_job_id", "value": "", "type": "path", "description": "The Evaluation Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Evaluation Job" }, { "info": { "name": "Delete Evaluation Job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluationJobs/:evaluation_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluation_job_id", "value": "", "type": "path", "description": "The Evaluation Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Evaluation Job" }, { "info": { "name": "Get Evaluation Job execution logs (stream log endpoint + tracing IDs).", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluationJobs/:evaluation_job_id:getExecutionLogEndpoint", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluation_job_id", "value": "", "type": "path", "description": "The Evaluation Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Evaluation Job execution logs (stream log endpoint + tracing IDs)." }, { "info": { "name": "List Evaluations", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluations", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Evaluations" }, { "info": { "name": "Create Evaluation", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluations", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Evaluation" }, { "info": { "name": "Get Evaluation", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluations/:evaluation_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluation_id", "value": "", "type": "path", "description": "The Evaluation Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Evaluation" }, { "info": { "name": "TODO: Add Update Evaluation\nUpdate Evaluation\nrpc UpdateEvaluation(UpdateEvaluationRequest) returns (Evaluation) {\n option (google.api.http) = {\n patch: \"/v1/{evaluation.name=accounts/*/evaluations/*}\"\n body: \"evaluation\"\n };\n}\nDelete Evaluation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluations/:evaluation_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluation_id", "value": "", "type": "path", "description": "The Evaluation Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "TODO: Add Update Evaluation\nUpdate Evaluation\nrpc UpdateEvaluation(UpdateEvaluationRequest) returns (Evaluation) {\n option (google.api.http) = {\n patch: \"/v1/{evaluation.name=accounts/*/evaluations/*}\"\n body: \"evaluation\"\n };\n}\nDelete Evaluation" }, { "info": { "name": "Preview an evaluation with sample data", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluations/:evaluation_id:preview", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluation_id", "value": "", "type": "path", "description": "The Evaluation Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Preview an evaluation with sample data" }, { "info": { "name": "Validate evaluation assertions", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluations:validateAssertions", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate evaluation assertions" }, { "info": { "name": "List Evaluators", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists all evaluators for an account with pagination support." }, { "info": { "name": "Create Evaluator (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deprecated: Use CreateEvaluatorV2 instead" }, { "info": { "name": "Get Evaluator", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves an evaluator by name. Use this to monitor build progress after\ncreation (**step 6** in the [Create Evaluator](/api-reference/create-evaluator) workflow).\n\nPossible states:\n\n- `BUILDING` - Environment is being prepared\n- `ACTIVE` - Evaluator is ready to use\n- `BUILD_FAILED` - Check build logs via [Get Evaluator Build Log Endpoint](/api-reference/get-evaluator-build-log-endpoint)" }, { "info": { "name": "Update Evaluator", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id", "params": [ { "name": "prepareCodeUpload", "value": "", "type": "query", "description": "If true, prepare a new code upload/build attempt by transitioning the\nevaluator to BUILDING state. Can be used without update_mask." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates evaluator metadata (display_name, description, default_dataset).\nChanging `requirements` or `entry_point` triggers a rebuild. To upload new\nsource code, set `prepare_code_upload: true` then follow the upload flow." }, { "info": { "name": "Delete Evaluator", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes an evaluator and its associated versions and build artifacts." }, { "info": { "name": "List Evaluator Revisions", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id/versions", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query", "description": "Default order should be reverse chronological (newest first) per AIP-162." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Evaluator Revisions" }, { "info": { "name": "CRUD APIs for evaluator revisions (AIP-162).\nGet Evaluator Revision", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id/versions/:version_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for evaluator revisions (AIP-162).\nGet Evaluator Revision" }, { "info": { "name": "Delete Evaluator Revision (deletes alias if name is an alias per AIP-162)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id/versions/:version_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Evaluator Revision (deletes alias if name is an alias per AIP-162)" }, { "info": { "name": "Alias Evaluator Revision - assign or update a user-specified alias", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id/versions/:version_id:alias", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Alias Evaluator Revision - assign or update a user-specified alias" }, { "info": { "name": "Rollback Evaluator to a specific revision", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id/versions/:version_id:rollback", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Rollback Evaluator to a specific revision" }, { "info": { "name": "Get Evaluator Build Log Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id:getBuildLogEndpoint", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a signed URL to download the evaluator's build logs. Useful for\ndebugging `BUILD_FAILED` state." }, { "info": { "name": "Get Evaluator Source Code Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id:getSourceCodeSignedUrl", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a signed URL to download the evaluator's source code archive.\nUseful for debugging or reviewing the uploaded code." }, { "info": { "name": "Get Evaluator Upload Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id:getUploadEndpoint", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns signed URLs for uploading evaluator source code (**step 3** in the\n[Create Evaluator](/api-reference/create-evaluator) workflow). After receiving\nthe signed URL, upload your `.tar.gz` archive using HTTP `PUT` with\n`Content-Type: application/octet-stream` header." }, { "info": { "name": "Validate Evaluator Upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators/:evaluator_id:validateUpload", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "evaluator_id", "value": "", "type": "path", "description": "The Evaluator Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Triggers server-side validation of the uploaded source code (**step 5** in\nthe [Create Evaluator](/api-reference/create-evaluator) workflow). The server\nextracts and processes the archive, then builds the evaluator environment.\nPoll [Get Evaluator](/api-reference/get-evaluator) to monitor progress." }, { "info": { "name": "Gateway_PreviewEvaluator", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluators:previewEvaluator", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Create Evaluator", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/evaluatorsV2", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a custom evaluator for scoring model outputs. Evaluators use the\n[Eval Protocol](https://evalprotocol.io) to define test cases, run model\ninference, and score responses. They are used with evaluation jobs and\nReinforcement Fine-Tuning (RFT).\n\n## Source Code Requirements\n\nYour project should contain:\n- `requirements.txt` - Python dependencies for your evaluator\n- `test_*.py` - Pytest test file(s) with\n [`@evaluation_test`](https://evalprotocol.io/reference/evaluation-test)\n decorated fu" }, { "info": { "name": "List the generic deployment types under an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of generic deployment types to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListGenericDeploymentTypeRequest call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListGenericDeploymentTypeRequest must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only generic deployments satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List the generic deployment types under an account" }, { "info": { "name": "Create Generic Deployment Type", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes", "params": [ { "name": "genericDeploymentTypeId", "value": "", "type": "query", "description": "The id of the generic deployment type" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Generic Deployment Type" }, { "info": { "name": "List all generic deployment type version", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes/:generic_deployment_type_id", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of generic deployment type versions to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListGenericDeploymentTypeVersionRequest call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListGenericDeploymentTypeVersionRequest must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only generic deployment type versions satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_type_id", "value": "", "type": "path", "description": "The Generic Deployment Type Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all generic deployment type version" }, { "info": { "name": "Update Generic Deployment Type", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes/:generic_deployment_type_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_type_id", "value": "", "type": "path", "description": "The Generic Deployment Type Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Generic Deployment Type" }, { "info": { "name": "Delete Generic Deployment Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes/:generic_deployment_type_id", "params": [ { "name": "hard", "value": "", "type": "query", "description": "If true, this will perform a hard deletion." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_type_id", "value": "", "type": "path", "description": "The Generic Deployment Type Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Generic Deployment Type" }, { "info": { "name": "Get generic deployment type version", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes/:generic_deployment_type_id/versions/:version_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_type_id", "value": "", "type": "path", "description": "The Generic Deployment Type Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get generic deployment type version" }, { "info": { "name": "Delete the generic deployment type version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeploymentTypes/:generic_deployment_type_id/versions/:version_id", "params": [ { "name": "hard", "value": "", "type": "query", "description": "If true, this will perform a hard deletion." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_type_id", "value": "", "type": "path", "description": "The Generic Deployment Type Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete the generic deployment type version" }, { "info": { "name": "List all the generic deployments under an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeployments", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of generic deployments to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListGenericDeploymentRequest call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListGenericDeploymentRequest must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only generic deployments satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all the generic deployments under an account" }, { "info": { "name": "Create Generic Deployment", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeployments", "params": [ { "name": "genericDeploymentId", "value": "", "type": "query", "description": "The ID of the deployment. If not specified, a random ID will be generated." }, { "name": "validateOnly", "value": "", "type": "query", "description": "If true, this will not create the deployment, but will return the deployment\nthat would be created." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Generic Deployment" }, { "info": { "name": "Get Generic Deployment", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeployments/:generic_deployment_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_id", "value": "", "type": "path", "description": "The Generic Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Generic Deployment" }, { "info": { "name": "Create Generic Deployment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeployments/:generic_deployment_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_id", "value": "", "type": "path", "description": "The Generic Deployment Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Generic Deployment" }, { "info": { "name": "Delete Generic Deployment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/genericDeployments/:generic_deployment_id", "params": [ { "name": "hard", "value": "", "type": "query", "description": "If true, this will perform a hard deletion." }, { "name": "ignoreChecks", "value": "", "type": "query", "description": "If true, this will ignore checks and force the deletion of a deployment that is currently\ndeployed and is in use." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "generic_deployment_id", "value": "", "type": "path", "description": "The Generic Deployment Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Generic Deployment" }, { "info": { "name": "List Identity Providers", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/identityProviders", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageToken", "value": "", "type": "query", "description": "Page token" }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression" }, { "name": "orderBy", "value": "", "type": "query", "description": "Order by" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Identity Providers" }, { "info": { "name": "Create Identity Provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/identityProviders", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Identity Provider" }, { "info": { "name": "Get Identity Provider", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/identityProviders/:identity_provider_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "identity_provider_id", "value": "", "type": "path", "description": "The Identity Provider Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Identity Provider" }, { "info": { "name": "Update Identity Provider", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/identityProviders/:identity_provider_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "identity_provider_id", "value": "", "type": "path", "description": "The Identity Provider Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Identity Provider" }, { "info": { "name": "Delete Identity Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/identityProviders/:identity_provider_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "identity_provider_id", "value": "", "type": "path", "description": "The Identity Provider Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Identity Provider" }, { "info": { "name": "List Models", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of models to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListModels call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListModels must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only model satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Models" }, { "info": { "name": "Create Model", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Model" }, { "info": { "name": "Get Model", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Model" }, { "info": { "name": "Update Model", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Model" }, { "info": { "name": "Delete Model", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Model" }, { "info": { "name": "CRUD APIs for model versions.\nCreate Model Version", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id/versions", "params": [ { "name": "versionId", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for model versions.\nCreate Model Version" }, { "info": { "name": "Deploy Model Version", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id/versions/:version_id:deploy", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deploy Model Version" }, { "info": { "name": "Returns the number of model versions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id/versions:count", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the number of model versions." }, { "info": { "name": "Get Model Download Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id:getDownloadEndpoint", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Model Download Endpoint" }, { "info": { "name": "Get Model Upload Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id:getUploadEndpoint", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Model Upload Endpoint" }, { "info": { "name": "Transfer model from S3 to GCP storage", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id:import", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Transfer model from S3 to GCP storage" }, { "info": { "name": "Prepare Model for different precisions", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id:prepare", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Prepare Model for different precisions" }, { "info": { "name": "Validate Model Upload", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/models/:model_id:validateUpload", "params": [ { "name": "skipHfConfigValidation", "value": "", "type": "query", "description": "If true, skip the Hugging Face config validation." }, { "name": "trustRemoteCode", "value": "", "type": "query", "description": "If true, trusts remote code when validating the Hugging Face config." }, { "name": "configOnly", "value": "", "type": "query", "description": "If true, skip tokenizer and parameter name validation." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "model_id", "value": "", "type": "path", "description": "The Model Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate Model Upload" }, { "info": { "name": "Returns the singleton PolicySettings for the given account.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/policySettings", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the singleton PolicySettings for the given account." }, { "info": { "name": "Updates the per-account PolicySettings singleton.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/policySettings", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the per-account PolicySettings singleton." }, { "info": { "name": "List Pricing Plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/pricingPlans", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Maximum number of pricing plans to return" }, { "name": "pageToken", "value": "", "type": "query", "description": "Page token from a previous ListPricingPlans call" }, { "name": "filter", "value": "", "type": "query", "description": "Filter expression (e.g., \"state=READY\")" }, { "name": "orderBy", "value": "", "type": "query", "description": "Order by expression (e.g., \"create_time desc\")" }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Pricing Plans" }, { "info": { "name": "CRUD APIs for pricing plans.\nGet Pricing Plan", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/pricingPlans/:pricing_plan_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "pricing_plan_id", "value": "", "type": "path", "description": "The Pricing Plan Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for pricing plans.\nGet Pricing Plan" }, { "info": { "name": "List Quotas", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/quotas", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of quotas to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListQuotas call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListQuotas must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only quota satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists all quotas for an account." }, { "info": { "name": "Get Quota", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/quotas/:quota_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "quota_id", "value": "", "type": "path", "description": "The Quota Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a single quota by resource name." }, { "info": { "name": "Update Quota", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/quotas/:quota_id", "params": [ { "name": "allowMissing", "value": "", "type": "query", "description": "If true, and the quota does not exist, it will be created." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "quota_id", "value": "", "type": "path", "description": "The Quota Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates a quota." }, { "info": { "name": "List Reinforcement Fine-tuning Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of fine-tuning jobs to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListReinforcementLearningFineTuningJobs call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListReinforcementLearningFineTuningJobs must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria for the returned jobs. See https://google.aip.dev/160 for the filter syntax specification." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Reinforcement Fine-tuning Jobs" }, { "info": { "name": "Create Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs", "params": [ { "name": "reinforcementFineTuningJobId", "value": "", "type": "query", "description": "ID of the reinforcement fine-tuning job, a random UUID will be generated if not specified." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Reinforcement Fine-tuning Job" }, { "info": { "name": "Get Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Reinforcement Fine-tuning Job" }, { "info": { "name": "Update Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Reinforcement Fine-tuning Job" }, { "info": { "name": "Delete Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Reinforcement Fine-tuning Job" }, { "info": { "name": "Cancel Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id:cancel", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel Reinforcement Fine-tuning Job" }, { "info": { "name": "Debug Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id:debug", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Debug Reinforcement Fine-tuning Job" }, { "info": { "name": "Gateway_GetReinforcementFineTuningJobMetricsFileEndpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id:getMetricsFileEndpoint", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Resume Reinforcement Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/reinforcementFineTuningJobs/:reinforcement_fine_tuning_job_id:resume", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "reinforcement_fine_tuning_job_id", "value": "", "type": "path", "description": "The Reinforcement Fine-tuning Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume Reinforcement Fine-tuning Job" }, { "info": { "name": "List Reinforcement Fine-tuning Steps", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of fine-tuning jobs to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListRlorTuningJobs call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListRlorTuningJobs must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria for the returned jobs. See https://google.aip.dev/160 for the filter syntax specification." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Reinforcement Fine-tuning Steps" }, { "info": { "name": "Create Reinforcement Fine-tuning Step", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs", "params": [ { "name": "rlorTrainerJobId", "value": "", "type": "query", "description": "ID of the RLOR trainer job, a random UUID will be generated if not specified." }, { "name": "trainingShape", "value": "", "type": "query", "description": "Optional validated training-shape selector for service-mode launches.\nAccepted formats:\n- accounts/{account}/trainingShapes/{shape}\n- accounts/{account}/trainingShapes/{shape}/versions/{version}\n- accounts/{account}/trainingShapes/{shape}/versions/latest\nWhen a shape (without /versions/*) is provided, the latest validated version is used." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Reinforcement Fine-tuning Step" }, { "info": { "name": "Get Reinforcement Fine-tuning Step", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Reinforcement Fine-tuning Step" }, { "info": { "name": "Delete Reinforcement Fine-tuning Step", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Reinforcement Fine-tuning Step" }, { "info": { "name": "List checkpoints for an RLOR Trainer Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id/checkpoints", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Maximum number of checkpoints to return. Default is 50, max is 200." }, { "name": "pageToken", "value": "", "type": "query", "description": "Page token from a previous call." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List checkpoints for an RLOR Trainer Job" }, { "info": { "name": "Get a signed URL for the public trainer logs of an RLOR Trainer Job.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id/publicLogs", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a signed URL for the public trainer logs of an RLOR Trainer Job." }, { "info": { "name": "Cancel Rlor Trainer Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id:cancel", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel Rlor Trainer Job" }, { "info": { "name": "Execute one training step for keep-alive Reinforcement Fine-tuning Step", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id:executeTrainStep", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Execute one training step for keep-alive Reinforcement Fine-tuning Step" }, { "info": { "name": "Resume Rlor Trainer Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/rlorTrainerJobs/:rlor_trainer_job_id:resume", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "rlor_trainer_job_id", "value": "", "type": "path", "description": "The Rlor Trainer Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume Rlor Trainer Job" }, { "info": { "name": "List Routers", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/routers", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of routers to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListRouters call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListRouters must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria for the returned routers. See https://google.aip.dev/160 for the filter syntax specification." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Routers" }, { "info": { "name": "Create Router", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/routers", "params": [ { "name": "routerId", "value": "", "type": "query", "description": "ID of the router." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Router" }, { "info": { "name": "CRUD APIs for routers.\nGet Router", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/routers/:router_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "router_id", "value": "", "type": "path", "description": "The Router Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for routers.\nGet Router" }, { "info": { "name": "Update Router", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/routers/:router_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "router_id", "value": "", "type": "path", "description": "The Router Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Router" }, { "info": { "name": "Delete Router", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/routers/:router_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "router_id", "value": "", "type": "path", "description": "The Router Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Router" }, { "info": { "name": "List Secrets", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/secrets", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query", "description": "Unused but required to use existing ListRequest functionality." }, { "name": "orderBy", "value": "", "type": "query", "description": "Unused but required to use existing ListRequest functionality." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists all secrets for an account. Note that the `value` field is not returned in the response for security reasons. Only the `name` and `key_name` fields are included for each secret." }, { "info": { "name": "Gateway_CreateSecret", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/secrets", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Get Secret", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/secrets/:secret_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "secret_id", "value": "", "type": "path", "description": "The Secret Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a secret by name. Note that the `value` field is not returned in the response for security reasons. Only the `name` and `key_name` fields are included." }, { "info": { "name": "Gateway_UpdateSecret", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/secrets/:secret_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "secret_id", "value": "", "type": "path", "description": "The Secret Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Gateway_DeleteSecret", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/secrets/:secret_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "secret_id", "value": "", "type": "path", "description": "The Secret Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "Lists effective global rate limits for shared serverless pool deployments (fireworks-owned).\nValues reflect configured limits as observed in production monitoring.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/serverlessRateLimits", "params": [ { "name": "deployment", "value": "", "type": "query", "description": "If set, only return limits for this deployment resource name." }, { "name": "start", "value": "", "type": "query", "description": "Start of the time range for time series data. Defaults to 30 days before `end`." }, { "name": "end", "value": "", "type": "query", "description": "End of the time range for time series data. Defaults to the request time." }, { "name": "interval", "value": "", "type": "query", "description": "Step size for the time series: each point is the peak effective limit observed within that\nwindow. Defaults to 4 hours." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists effective global rate limits for shared serverless pool deployments (fireworks-owned).\nValues reflect configured limits as observed in production monitoring." }, { "info": { "name": "Serverless pool token throughput (tokens per minute) by time bucket and base model, from\nproduction usage metrics.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/serverlessTokenUsage", "params": [ { "name": "start", "value": "", "type": "query", "description": "Start of the time range. Defaults to 30 days before `end`." }, { "name": "end", "value": "", "type": "query", "description": "End of the time range. Defaults to the request time." }, { "name": "interval", "value": "", "type": "query", "description": "Step size for each point (peak or average TPM within each window). Defaults to 4 hours." }, { "name": "includePeakTokensPerMinuteByBaseModel", "value": "", "type": "query", "description": "Whether to include each section in the response. At least one must be true; otherwise the\nrequest fails with INVALID_ARGUMENT." }, { "name": "includeAverageTokensPerMinuteByBaseModel", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Serverless pool token throughput (tokens per minute) by time bucket and base model, from\nproduction usage metrics." }, { "info": { "name": "List Supervised Fine-tuning Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of fine-tuning jobs to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListSupervisedFineTuningJobs call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListSupervisedFineTuningJobs must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria for the returned jobs. See https://google.aip.dev/160 for the filter syntax specification." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Supervised Fine-tuning Jobs" }, { "info": { "name": "Create Supervised Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs", "params": [ { "name": "supervisedFineTuningJobId", "value": "", "type": "query", "description": "ID of the supervised fine-tuning job, a random UUID will be generated if not specified." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Supervised Fine-tuning Job" }, { "info": { "name": "Get Supervised Fine-tuning Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs/:supervised_fine_tuning_job_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "supervised_fine_tuning_job_id", "value": "", "type": "path", "description": "The Supervised Fine-tuning Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Supervised Fine-tuning Job" }, { "info": { "name": "Delete Supervised Fine-tuning Job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs/:supervised_fine_tuning_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "supervised_fine_tuning_job_id", "value": "", "type": "path", "description": "The Supervised Fine-tuning Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Supervised Fine-tuning Job" }, { "info": { "name": "Cancel Supervised Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs/:supervised_fine_tuning_job_id:cancel", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "supervised_fine_tuning_job_id", "value": "", "type": "path", "description": "The Supervised Fine-tuning Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel Supervised Fine-tuning Job" }, { "info": { "name": "Resume Supervised Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs/:supervised_fine_tuning_job_id:resume", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "supervised_fine_tuning_job_id", "value": "", "type": "path", "description": "The Supervised Fine-tuning Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume Supervised Fine-tuning Job" }, { "info": { "name": "Estimate the cost of a Supervised Fine-tuning Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/supervisedFineTuningJobs:estimateCost", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Estimate the cost of a Supervised Fine-tuning Job" }, { "info": { "name": "List Trails", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trails", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of trails to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListTrails call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListTrails must match the call that provided the page token." }, { "name": "filter", "value": "", "type": "query", "description": "Filter criteria for the returned trails. See https://google.aip.dev/160\nfor the filter syntax specification." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"create_time,display_name\"\nThe default sort order is ascending. To specify descending order for a\nfield, append a \" desc\" suffix. e.g. \"create_time desc\"\nIf not specified, the default order is by \"create_time desc\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Trails" }, { "info": { "name": "Create Trail", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trails", "params": [ { "name": "trailId", "value": "", "type": "query", "description": "Optional ID for the trail. If not specified, a random UUID will be generated." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Trail" }, { "info": { "name": "CRUD APIs for trails.\nGet Trail", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trails/:trail_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "trail_id", "value": "", "type": "path", "description": "The Trail Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for trails.\nGet Trail" }, { "info": { "name": "Update Trail", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trails/:trail_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "trail_id", "value": "", "type": "path", "description": "The Trail Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Trail" }, { "info": { "name": "Delete Trail", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trails/:trail_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "trail_id", "value": "", "type": "path", "description": "The Trail Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Trail" }, { "info": { "name": "Get Trail Metrics (trace counts, token usage from tracing service)", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trails/:trail_id:getMetrics", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "trail_id", "value": "", "type": "path", "description": "The Trail Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Trail Metrics (trace counts, token usage from tracing service)" }, { "info": { "name": "List training session jobs for an account.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "readMask", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List training session jobs for an account." }, { "info": { "name": "Create a training session job that binds an account to a shared trainer.", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs", "params": [ { "name": "trainingSessionJobId", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a training session job that binds an account to a shared trainer." }, { "info": { "name": "Get a training session job.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs/:training_session_job_id", "params": [ { "name": "readMask", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_session_job_id", "value": "", "type": "path", "description": "The Training Session Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a training session job." }, { "info": { "name": "Delete a training session job and cascade-clean its child sessions and routes.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs/:training_session_job_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_session_job_id", "value": "", "type": "path", "description": "The Training Session Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a training session job and cascade-clean its child sessions and routes." }, { "info": { "name": "List training sessions under a training session job.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs/:training_session_job_id/trainingSessions", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageToken", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "readMask", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_session_job_id", "value": "", "type": "path", "description": "The Training Session Job Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List training sessions under a training session job." }, { "info": { "name": "Create a training session under a training session job.", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs/:training_session_job_id/trainingSessions", "params": [ { "name": "trainingSessionId", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_session_job_id", "value": "", "type": "path", "description": "The Training Session Job Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a training session under a training session job." }, { "info": { "name": "Get a training session.", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs/:training_session_job_id/trainingSessions/:training_session_id", "params": [ { "name": "readMask", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_session_job_id", "value": "", "type": "path", "description": "The Training Session Job Id" }, { "name": "training_session_id", "value": "", "type": "path", "description": "The Training Session Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a training session." }, { "info": { "name": "Load or switch the LoRA adapter state for a training session.", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingSessionJobs/:training_session_job_id/trainingSessions/:training_session_id:loadState", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_session_job_id", "value": "", "type": "path", "description": "The Training Session Job Id" }, { "name": "training_session_id", "value": "", "type": "path", "description": "The Training Session Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load or switch the LoRA adapter state for a training session." }, { "info": { "name": "List Training Shapes", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. Max page_size is 200; values above 200 are coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token from a previous ListTrainingShapes call." }, { "name": "filter", "value": "", "type": "query", "description": "Filter per AIP-160." }, { "name": "orderBy", "value": "", "type": "query", "description": "Order by fields, default \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Training Shapes" }, { "info": { "name": "CRUD APIs for training shape.\nCreate Training Shape", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes", "params": [ { "name": "trainingShapeId", "value": "", "type": "query", "description": "The ID of the training shape. If not specified, a random ID will be generated.\nMust follow AIP-122 segment format and start with a letter." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "CRUD APIs for training shape.\nCreate Training Shape" }, { "info": { "name": "Get Training Shape", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes/:training_shape_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_shape_id", "value": "", "type": "path", "description": "The Training Shape Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Training Shape" }, { "info": { "name": "Update Training Shape", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes/:training_shape_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_shape_id", "value": "", "type": "path", "description": "The Training Shape Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Training Shape" }, { "info": { "name": "Delete Training Shape", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes/:training_shape_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_shape_id", "value": "", "type": "path", "description": "The Training Shape Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Training Shape" }, { "info": { "name": "List Training Shapes Versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes/:training_shape_id/versions", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of versions to return. Max page_size is 200; values above 200 are coerced.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token from a previous ListTrainingShapeVersions call." }, { "name": "filter", "value": "", "type": "query", "description": "Filter per AIP-160." }, { "name": "orderBy", "value": "", "type": "query", "description": "Order by fields, default \"create_time\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_shape_id", "value": "", "type": "path", "description": "The Training Shape Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Training Shapes Versions" }, { "info": { "name": "Get Training Shape Version", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes/:training_shape_id/versions/:version_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_shape_id", "value": "", "type": "path", "description": "The Training Shape Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Training Shape Version" }, { "info": { "name": "Update Training Shape Version", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/trainingShapes/:training_shape_id/versions/:version_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "training_shape_id", "value": "", "type": "path", "description": "The Training Shape Id" }, { "name": "version_id", "value": "", "type": "path", "description": "The Version Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Training Shape Version" }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of users to return. The maximum page_size is 200,\nvalues above 200 will be coerced to 200.\nIf unspecified, the default is 50." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous ListUsers call. Provide this\nto retrieve the subsequent page. When paginating, all other parameters\nprovided to ListUsers must match the call that provided the page\ntoken." }, { "name": "filter", "value": "", "type": "query", "description": "Only users satisfying the provided filter (if specified) will be\nreturned. See https://google.aip.dev/160 for the filter grammar." }, { "name": "orderBy", "value": "", "type": "query", "description": "A comma-separated list of fields to order by. e.g. \"foo,bar\"\nThe default sort order is ascending. To specify a descending order for a\nfield, append a \" desc\" suffix. e.g. \"foo desc,bar\"\nSubfields are specified with a \".\" character. e.g. \"foo.bar\"\nIf not specified, the default order is by \"name\"." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Users" }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users", "params": [ { "name": "userId", "value": "", "type": "query", "description": "The user ID to use in the user name. e.g. my-user\nIf not specified, a default ID is generated from user.email." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create User" }, { "info": { "name": "Get User", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users/:user_id", "params": [ { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "user_id", "value": "", "type": "path", "description": "The User Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get User" }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users/:user_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "user_id", "value": "", "type": "path", "description": "The User Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update User" }, { "info": { "name": "List API Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users/:user_id/apiKeys", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Number of API keys to return in the response. Pagination support to be added." }, { "name": "pageToken", "value": "", "type": "query", "description": "Token for fetching the next page of results. Pagination support to be added." }, { "name": "filter", "value": "", "type": "query", "description": "Field for filtering results." }, { "name": "orderBy", "value": "", "type": "query", "description": "Field for ordering results." }, { "name": "readMask", "value": "", "type": "query", "description": "The fields to be returned in the response. If empty or \"*\", all fields will be returned." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "user_id", "value": "", "type": "path", "description": "The User Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List API Keys" }, { "info": { "name": "Create API Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users/:user_id/apiKeys", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "user_id", "value": "", "type": "path", "description": "The User Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create API Key" }, { "info": { "name": "Get API Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users/:user_id/apiKeys/accounts/:account_id/users/:user_id", "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The key ID for the API key." }, { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "user_id", "value": "", "type": "path", "description": "The User Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get API Key" }, { "info": { "name": "Delete API Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id/users/:user_id/apiKeys:delete", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" }, { "name": "user_id", "value": "", "type": "path", "description": "The User Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete API Key" }, { "info": { "name": "Similar to preview evaluation, but no need to create the evaluation entry first.", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireworks.ai/inference/v1/accounts/:account_id:testeval", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Account Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Similar to preview evaluation, but no need to create the evaluation entry first." } ] } ], "bundled": true }