> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For full documentation content, see https://platform.bctrl.ai/llms-full.txt.

# Agent Context

GET https://api.bctrl.ai/v1/spaces/{id}/agent-context

Fetch a compact context bundle for an agent working in a space. Use this before deciding what to do with the space, its runtimes, storage, tools, and activity.

Reference: https://platform.bctrl.ai/api/api-reference/spaces/agent-context

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/spaces/{id}/agent-context:
    get:
      operationId: agent-context
      summary: Machine-readable guide for coding agents
      description: >-
        Fetch a compact context bundle for an agent working in a space. Use this
        before deciding what to do with the space, its runtimes, storage, tools,
        and activity.
      tags:
        - subpackage_spaces
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: runtimeId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: topic
          in: query
          required: false
          schema:
            type: string
        - name: detail
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1SpacesIdAgentContextGetParametersDetail'
        - name: include
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1SpacesIdAgentContextGetParametersInclude'
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/spaces_agentContext_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1SpacesIdAgentContextGetParametersDetail:
      type: string
      enum:
        - compact
        - full
      title: V1SpacesIdAgentContextGetParametersDetail
    V1SpacesIdAgentContextGetParametersInclude:
      oneOf:
        - type: string
          enum:
            - examples
        - type: array
          items:
            type: string
            enum:
              - examples
      title: V1SpacesIdAgentContextGetParametersInclude
    V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaOperationsItems:
      type: object
      properties:
        id:
          type: string
        input:
          description: Any type
        method:
          type: string
        output:
          description: Any type
        path:
          type: string
        whenToUse:
          type: string
      required:
        - id
        - method
        - path
        - whenToUse
      title: >-
        V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaOperationsItems
    V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntimeStatus:
      type: string
      enum:
        - active
        - stopped
        - failed
      title: >-
        V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntimeStatus
    V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntimeType:
      type: string
      enum:
        - browser
        - desktop
        - spreadsheet
      title: >-
        V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntimeType
    V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntime:
      type: object
      properties:
        activeRunId:
          type:
            - string
            - 'null'
          format: uuid
        capabilities:
          type: array
          items:
            type: string
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          $ref: >-
            #/components/schemas/V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntimeStatus
        type:
          $ref: >-
            #/components/schemas/V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntimeType
      required:
        - activeRunId
        - capabilities
        - id
        - name
        - status
        - type
      title: V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntime
    V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaSpace:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        region:
          type: string
      required:
        - id
        - name
        - region
      title: V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaSpace
    spaces_agentContext_Response_200:
      type: object
      properties:
        examples:
          type: array
          items:
            description: Any type
        limits:
          type: object
          additionalProperties:
            type: number
            format: double
        links:
          type: object
          additionalProperties:
            type: string
        operations:
          type: array
          items:
            $ref: >-
              #/components/schemas/V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaOperationsItems
        rules:
          type: array
          items:
            type: string
        runtime:
          oneOf:
            - $ref: >-
                #/components/schemas/V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaRuntime
            - type: 'null'
        space:
          $ref: >-
            #/components/schemas/V1SpacesIdAgentContextGetResponsesContentApplicationJsonSchemaSpace
        version:
          type: string
      required:
        - examples
        - limits
        - links
        - operations
        - rules
        - runtime
        - space
        - version
      title: spaces_agentContext_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/spaces/id/agent-context"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/spaces/id/agent-context';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', '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.bctrl.ai/v1/spaces/id/agent-context"

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

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.bctrl.ai/v1/spaces/id/agent-context")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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.bctrl.ai/v1/spaces/id/agent-context")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/spaces/id/agent-context', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/spaces/id/agent-context");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/spaces/id/agent-context")! 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()
```