Download URL

Downloads content from the specified URI and returns the response.

Makes an HTTP GET request to the URI specified in the request, optionally routing through a proxy. Custom headers can be provided to customize the request.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

The UUID of the SoulFire instance to associate this download with. Used for permission checking - the caller must have DOWNLOAD_URL permission for this instance. Must be a valid UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

uri*string

The URI to download content from. Must be a valid, fully-formed URI (e.g., "https://example.com/resource.json"). The server will make an HTTP GET request to this URI.

Formaturi

headers.key*string

headers.value*string

proxy.type*

The proxy protocol type. Determines how the connection is established.

proxy.address*string

The proxy server address in "host:port" format (e.g., "proxy.example.com:8080"). The address must be resolvable and the port must be valid (1-65535).

proxy.username?string

Optional username for proxy authentication. Required if the proxy server requires authentication. If password is set, username must also be set.

proxy.password?string

Optional password for proxy authentication. Used with username for SOCKS5 or HTTP proxy authentication. Not supported for SOCKS4 proxies (will cause an error if set).

Response Body

`application/json`

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/downloads:fetch" \  -H "Content-Type: application/json" \  -d '{    "uri": "http://example.com",    "headers.key": "string",    "headers.value": "string",    "proxy.type": {},    "proxy.address": "string"  }'

{
  "data": "string",
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "status_code": 0
}

{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`