# Run an inference with a base model POST /v2/workspaces/{workspace\_id}/base-models/{slug}/inferences ```bash curl --request POST \ --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{}' ``` ```python import requests url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```js const url = 'https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```php "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => json_encode([ ]), CURLOPT_HTTPHEADER => [ "Authorization: Bearer ", "Content-Type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ``` ```java OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{}"); Request request = new Request.Builder() .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences") .post(body) .addHeader("Authorization", "Bearer ") .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute(); ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```csharp var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/:slug/inferences"); var request = new RestRequest("", Method.Post); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); var response = client.Execute(request); ``` * Production > **New in v2.** This endpoint has no v1 equivalent. Start a generation with the given base model. The request body is the model’s inference form (see GET /base-models/{slug}/inference-schema for its shape). Returns immediately with an inference id; poll GET /workspaces/{workspace\_id}/inferences/{inference\_id} for results. ## Authorizations * **[bearerAuth](/docs/v2/rest-api#bearerauth)** ## Parameters ### Path Parameters **workspace\_id** required _Workspace Id_ Id of the workspace that owns the resource. string format: uuid Id of the workspace that owns the resource. **slug** required _Slug_ URL-safe slug of the base model, as returned by the list base models endpoint. string URL-safe slug of the base model, as returned by the list base models endpoint. ### Query Parameters **session\_name** Any of: **string** string **null** null Organize this run under a named session. A new session is created if none matches. ## Request Bodyrequired _Input_object **_key_** additional properties any ##### Examplegenerated ```json {} ``` ## Responses ### 202 Successful Response _ExecuteForgeOutput_object **inference\_id** required _Inference Id_ Unique identifier for this forge run. string format: uuid **status** required _InferenceStatus_ Current status: IN\_PROGRESS. string Allowed values: in\_progress complete failed cancelled deleted **estimated\_price\_creative\_units** Any of: **number** number **null** null **poll\_interval\_seconds** required _Poll Interval Seconds_ Suggested polling interval in seconds. integer **created\_at** required _Created At_ Timestamp of when the run was created. string format: date-time **session\_id** Any of: **string** string format: uuid **null** null **normalized\_parameters** Any of: **NormalizedInferenceParameters** _NormalizedInferenceParameters_ Inference parameters after model-specific normalization. These reflect the actual values used for generation, including model defaults applied for any parameters not explicitly set. object **width** Any of: **null** integer **integer** null **height** Any of: **null** integer **integer** null **batch\_size** Any of: **null** integer **integer** null **num\_inference\_steps** Any of: **null** integer **integer** null **guidance\_scale** Any of: **null** number **number** null **duration\_seconds** Any of: **null** number **number** null **fps** Any of: **null** integer **integer** null **null** null ##### Example ```json { "status": "in_progress" } ``` ### 401 Unauthenticated — missing or invalid Bearer token. object **type** required string **title** required string **status** required integer **detail** required string ##### Example ```json { "type": "https://api.layer.ai/errors/ERROR_CODE", "title": "Error Title", "status": 400, "detail": "Human-readable description." } ``` ### 403 Forbidden — insufficient permissions. object **type** required string **title** required string **status** required integer **detail** required string ##### Example ```json { "type": "https://api.layer.ai/errors/ERROR_CODE", "title": "Error Title", "status": 400, "detail": "Human-readable description." } ``` ### 404 Resource not found. object **type** required string **title** required string **status** required integer **detail** required string ##### Example ```json { "type": "https://api.layer.ai/errors/ERROR_CODE", "title": "Error Title", "status": 400, "detail": "Human-readable description." } ``` ### 422 Invalid input parameters. object **type** required string **title** required string **status** required integer **detail** required string ##### Example ```json { "type": "https://api.layer.ai/errors/ERROR_CODE", "title": "Error Title", "status": 400, "detail": "Human-readable description." } ``` ### 429 Rate limited — too many concurrent requests. object **type** required string **title** required string **status** required integer **detail** required string ##### Example ```json { "type": "https://api.layer.ai/errors/ERROR_CODE", "title": "Error Title", "status": 400, "detail": "Human-readable description." } ``` ### 500 Internal server error. object **type** required string **title** required string **status** required integer **detail** required string ##### Example ```json { "type": "https://api.layer.ai/errors/ERROR_CODE", "title": "Error Title", "status": 400, "detail": "Human-readable description." } ```