# Upload file into workspace and register catalog metadata

POST https://api.bctrl.ai/v1/storage/objects

Reference: https://platform.bctrl.ai/api/api-reference/storage/objects-upload

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/storage/objects:
    post:
      operationId: objects-upload
      summary: Upload file into workspace and register catalog metadata
      tags:
        - subpackage_storage
      parameters:
        - 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/storage_objectsUpload_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    storage_objectsUpload_Response_200:
      type: object
      properties:
        contentType:
          type: string
        expiresAt:
          type:
            - string
            - 'null'
        filename:
          type: string
        id:
          type: string
          format: uuid
        logicalPath:
          type: string
        objectKey:
          type: string
        sizeBytes:
          type: integer
        workspace:
          type: string
      required:
        - contentType
        - expiresAt
        - filename
        - id
        - logicalPath
        - objectKey
        - sizeBytes
        - workspace
      title: storage_objectsUpload_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/storage/objects"

payload = {
    "workspace": "project-alpha",
    "logicalPath": "documents/reports/2024/financial-summary.pdf",
    "objectKey": "proj-alpha-2024-financial-summary-001",
    "filename": "financial-summary.pdf",
    "sizeBytes": 245760,
    "contentType": "application/pdf",
    "expiresAt": "2025-06-30T23:59:59Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/storage/objects';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"workspace":"project-alpha","logicalPath":"documents/reports/2024/financial-summary.pdf","objectKey":"proj-alpha-2024-financial-summary-001","filename":"financial-summary.pdf","sizeBytes":245760,"contentType":"application/pdf","expiresAt":"2025-06-30T23:59:59Z"}'
};

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/storage/objects"

	payload := strings.NewReader("{\n  \"workspace\": \"project-alpha\",\n  \"logicalPath\": \"documents/reports/2024/financial-summary.pdf\",\n  \"objectKey\": \"proj-alpha-2024-financial-summary-001\",\n  \"filename\": \"financial-summary.pdf\",\n  \"sizeBytes\": 245760,\n  \"contentType\": \"application/pdf\",\n  \"expiresAt\": \"2025-06-30T23:59:59Z\"\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://api.bctrl.ai/v1/storage/objects")

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  \"workspace\": \"project-alpha\",\n  \"logicalPath\": \"documents/reports/2024/financial-summary.pdf\",\n  \"objectKey\": \"proj-alpha-2024-financial-summary-001\",\n  \"filename\": \"financial-summary.pdf\",\n  \"sizeBytes\": 245760,\n  \"contentType\": \"application/pdf\",\n  \"expiresAt\": \"2025-06-30T23:59:59Z\"\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://api.bctrl.ai/v1/storage/objects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace\": \"project-alpha\",\n  \"logicalPath\": \"documents/reports/2024/financial-summary.pdf\",\n  \"objectKey\": \"proj-alpha-2024-financial-summary-001\",\n  \"filename\": \"financial-summary.pdf\",\n  \"sizeBytes\": 245760,\n  \"contentType\": \"application/pdf\",\n  \"expiresAt\": \"2025-06-30T23:59:59Z\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/storage/objects', [
  'body' => '{
  "workspace": "project-alpha",
  "logicalPath": "documents/reports/2024/financial-summary.pdf",
  "objectKey": "proj-alpha-2024-financial-summary-001",
  "filename": "financial-summary.pdf",
  "sizeBytes": 245760,
  "contentType": "application/pdf",
  "expiresAt": "2025-06-30T23:59:59Z"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/storage/objects");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"workspace\": \"project-alpha\",\n  \"logicalPath\": \"documents/reports/2024/financial-summary.pdf\",\n  \"objectKey\": \"proj-alpha-2024-financial-summary-001\",\n  \"filename\": \"financial-summary.pdf\",\n  \"sizeBytes\": 245760,\n  \"contentType\": \"application/pdf\",\n  \"expiresAt\": \"2025-06-30T23:59:59Z\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "workspace": "project-alpha",
  "logicalPath": "documents/reports/2024/financial-summary.pdf",
  "objectKey": "proj-alpha-2024-financial-summary-001",
  "filename": "financial-summary.pdf",
  "sizeBytes": 245760,
  "contentType": "application/pdf",
  "expiresAt": "2025-06-30T23:59:59Z"
] as [String : Any]

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

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