# Jobs Retrieve

GET /api/v2/orchestrations/jobs/{id}/

Base view for retrieving a single object instance.
Enforces authentication by default.

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/orchestrations/jobs-retrieve

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v2/orchestrations/jobs/{id}/:
    get:
      operationId: jobs-retrieve
      summary: Jobs Retrieve
      description: |-
        Base view for retrieving a single object instance.
        Enforces authentication by default.
      tags:
        - subpackage_orchestrations
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobPacket'
components:
  schemas:
    JobPacketTypeEnum:
      type: string
      enum:
        - BATCH_PLANNER
        - AUTOFILL
        - GENESIS
        - REGENERATION
        - VIDEO_DIRECTOR
        - VIDEO_SECTION_SCRIPTER
        - VIDEO_ASSET_AUDIO
        - VIDEO_ASSET_VISUAL
        - VIDEO_SECTION_MERGE
        - VIDEO_FINAL_MERGE
        - PODCAST_DIRECTOR
        - PODCAST_SCRIPTING
        - PODCAST_AUDIO
        - QUEST_GENERATION
        - ACTION_DIRECTOR
        - ACTION_CHAT
        - ACTION_EXECUTOR
        - QUEST_PROBLEMS
        - BLOG_GENERATION
        - BLOG_OUTLINE_GENERATION
        - BLOG_CONTENT_GENERATION
        - BLOG_KOENIG_GENERATION
        - EXPERT_GENERATION
        - EXPERT_PROMPTS
      description: |-
        * `BATCH_PLANNER` - Batch Planner
        * `AUTOFILL` - Autofill & Planning
        * `GENESIS` - Genesis (Creation)
        * `REGENERATION` - Regeneration
        * `VIDEO_DIRECTOR` - Video Director (Plan & Diff)
        * `VIDEO_SECTION_SCRIPTER` - Video Section Scripter
        * `VIDEO_ASSET_AUDIO` - Video Asset: Audio
        * `VIDEO_ASSET_VISUAL` - Video Asset: Visual
        * `VIDEO_SECTION_MERGE` - Video Section Assembly
        * `VIDEO_FINAL_MERGE` - Video Final Merge
        * `PODCAST_DIRECTOR` - Podcast Director (Plan)
        * `PODCAST_SCRIPTING` - Podcast Scripting
        * `PODCAST_AUDIO` - Podcast Audio Generation
        * `QUEST_GENERATION` - Quest Generation
        * `ACTION_DIRECTOR` - Action Director (Routing & Planning)
        * `ACTION_CHAT` - Action Chat (Guidance)
        * `ACTION_EXECUTOR` - Action Executor
        * `QUEST_PROBLEMS` - Quest Problem Suggestions
        * `BLOG_GENERATION` - Blog/Note Generation
        * `BLOG_OUTLINE_GENERATION` - Blog Outline Generation
        * `BLOG_CONTENT_GENERATION` - Blog Content Generation
        * `BLOG_KOENIG_GENERATION` - Blog Koenig Format Generation
        * `EXPERT_GENERATION` - Expert Generation
        * `EXPERT_PROMPTS` - Expert Prompt Suggestions
      title: JobPacketTypeEnum
    JobPacketStatusEnum:
      type: string
      enum:
        - PENDING
        - RUNNING
        - COMPLETED
        - FAILED
      description: |-
        * `PENDING` - Pending
        * `RUNNING` - Running
        * `COMPLETED` - Completed
        * `FAILED` - Failed
      title: JobPacketStatusEnum
    AgentEventTypeEnum:
      type: string
      enum:
        - LOG
        - THOUGHT
        - STATE_CHANGE
        - MESSAGE
        - END
      description: |-
        * `LOG` - Internal Log
        * `THOUGHT` - Reasoning/Thought
        * `STATE_CHANGE` - State Change
        * `MESSAGE` - Agent Message
        * `END` - Job Stream End
      title: AgentEventTypeEnum
    AgentEvent:
      type: object
      properties:
        id:
          type: integer
        uid:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        is_active:
          type: boolean
        created_by:
          type:
            - string
            - 'null'
        updated_by:
          type:
            - string
            - 'null'
        deleted_by:
          type:
            - string
            - 'null'
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
        type:
          $ref: '#/components/schemas/AgentEventTypeEnum'
        content:
          type: string
          description: Human readable message
        metadata:
          description: Structured data for the event
      required:
        - id
        - uid
        - created_at
        - updated_at
        - is_active
        - created_by
        - updated_by
        - deleted_by
        - deleted_at
        - type
        - content
        - metadata
      title: AgentEvent
    JobPacket:
      type: object
      properties:
        id:
          type: integer
        uid:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        is_active:
          type: boolean
        created_by:
          type:
            - string
            - 'null'
        updated_by:
          type:
            - string
            - 'null'
        deleted_by:
          type:
            - string
            - 'null'
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
        type:
          $ref: '#/components/schemas/JobPacketTypeEnum'
        status:
          $ref: '#/components/schemas/JobPacketStatusEnum'
        result:
          oneOf:
            - description: Any type
            - type: 'null'
          description: Output results (IDs, Handoffs)
        error_message:
          type:
            - string
            - 'null'
        events:
          type: array
          items:
            $ref: '#/components/schemas/AgentEvent'
      required:
        - id
        - uid
        - created_at
        - updated_at
        - is_active
        - created_by
        - updated_by
        - deleted_by
        - deleted_at
        - type
        - status
        - result
        - error_message
        - events
      title: JobPacket

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v2/orchestrations/jobs/1/"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v2/orchestrations/jobs/1/';
const options = {method: 'GET', headers: {'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.example.com/api/v2/orchestrations/jobs/1/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	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))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/orchestrations/jobs/1/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v2/orchestrations/jobs/1/")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/api/v2/orchestrations/jobs/1/', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v2/orchestrations/jobs/1/");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v2/orchestrations/jobs/1/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```