> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.astropods.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.astropods.com/_mcp/server.

# Reserve a deployment file

POST https://astropods.com/api/v1/deployments/{deploymentId}/files
Content-Type: application/json

Starts a two-step upload. Reserves an opaque key and returns an upload
descriptor; no file bytes are sent in this request. The client must upload
the bytes successfully before the key can be listed, downloaded, or attached
to a chat message. A relative upload URL is resolved against this collection
URL; an absolute URL is a presigned object-store target and is used unchanged.


Reference: https://docs.astropods.com/api-reference/astro-ai-api/files/create-deployment-file

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: astro-api
  version: 1.0.0
paths:
  /deployments/{deploymentId}/files:
    post:
      operationId: create-deployment-file
      summary: Reserve a deployment file
      description: >
        Starts a two-step upload. Reserves an opaque key and returns an upload

        descriptor; no file bytes are sent in this request. The client must
        upload

        the bytes successfully before the key can be listed, downloaded, or
        attached

        to a chat message. A relative upload URL is resolved against this
        collection

        URL; an absolute URL is a presigned object-store target and is used
        unchanged.
      tags:
        - files
      parameters:
        - name: deploymentId
          in: path
          description: Deployment ID
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: OAuth 2.0 device flow or platform session token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Reserved key and upload target
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDeploymentFileResponse'
        '400':
          description: Invalid request body or parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient permissions for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Declared file size exceeds the active upload limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service not configured or unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '507':
          description: The deployment volume cannot fit the file and required reserve
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentFileRequest'
servers:
  - url: https://astropods.com/api/v1
    description: Astro AI API server
components:
  schemas:
    CreateDeploymentFileRequest:
      type: object
      properties:
        name:
          type: string
          description: >-
            Display filename. Must not contain path separators or control
            characters.
        content_type:
          type: string
          description: MIME type; defaults to application/octet-stream when empty.
        size:
          type: integer
          format: int64
          description: >-
            Exact declared byte size. Used as the upload ceiling and capacity
            reservation.
      required:
        - name
        - size
      title: CreateDeploymentFileRequest
    DeploymentFile:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        size:
          type: integer
          format: int64
        content_type:
          type: string
        updated_at:
          type: string
          format: date-time
        uploaded_by:
          type: string
          description: Opaque owner identity. Omitted when not applicable.
      required:
        - key
        - name
        - size
        - content_type
        - updated_at
      title: DeploymentFile
    DeploymentFileUploadDescriptor:
      type: object
      properties:
        url:
          type: string
          description: Relative Files API content path or absolute presigned URL.
        method:
          type: string
        headers:
          type: object
          additionalProperties:
            type: string
      required:
        - url
        - method
      title: DeploymentFileUploadDescriptor
    CreateDeploymentFileResponse:
      type: object
      properties:
        key:
          type: string
        file:
          $ref: '#/components/schemas/DeploymentFile'
        upload:
          $ref: '#/components/schemas/DeploymentFileUploadDescriptor'
      required:
        - key
        - file
        - upload
      title: CreateDeploymentFileResponse
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: string
      title: Error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 device flow or platform session token

```

## Examples



**Request**

```json
{
  "name": "agent-logs.txt",
  "size": 1048576
}
```

**Response**

```json
{
  "key": "file_9f8b7c6d5e4a3b2c1d0e",
  "file": {
    "key": "file_9f8b7c6d5e4a3b2c1d0e",
    "name": "agent-logs.txt",
    "size": 1048576,
    "content_type": "text/plain",
    "updated_at": "2024-01-15T09:30:00Z",
    "uploaded_by": "user_12345"
  },
  "upload": {
    "url": "/deployments/abc123/files/file_9f8b7c6d5e4a3b2c1d0e/upload",
    "method": "PUT",
    "headers": {}
  }
}
```

**SDK Code**

```python
import requests

url = "https://astropods.com/api/v1/deployments/deploymentId/files"

payload = {
    "name": "agent-logs.txt",
    "size": 1048576
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://astropods.com/api/v1/deployments/deploymentId/files';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"agent-logs.txt","size":1048576}'
};

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://astropods.com/api/v1/deployments/deploymentId/files"

	payload := strings.NewReader("{\n  \"name\": \"agent-logs.txt\",\n  \"size\": 1048576\n}")

	req, _ := http.NewRequest("POST", 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://astropods.com/api/v1/deployments/deploymentId/files")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"agent-logs.txt\",\n  \"size\": 1048576\n}"

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.post("https://astropods.com/api/v1/deployments/deploymentId/files")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"agent-logs.txt\",\n  \"size\": 1048576\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://astropods.com/api/v1/deployments/deploymentId/files', [
  'body' => '{
  "name": "agent-logs.txt",
  "size": 1048576
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://astropods.com/api/v1/deployments/deploymentId/files");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"agent-logs.txt\",\n  \"size\": 1048576\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "agent-logs.txt",
  "size": 1048576
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://astropods.com/api/v1/deployments/deploymentId/files")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```