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

# Assign extractor

POST http://localhost:3200/v1/clientApplication/{clientApplicationId}/extractors
Content-Type: application/json

Reference: https://cla-demo.postmansolutions.com/api-reference/registration/extractors/assign

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `clientApplicationId` (string, required)

### Body (application/json)

This endpoint expects an object.

- `extractionUrl` (string, required)
- `apiKey` (string, required)
- `pollingUrl` (string, required, nullable)
- `extractorTypeId` (string, required)
- `jobTrackingConfig` (V1ClientApplicationClientApplicationIdExtractorsPostRequestBodyContentApplicationJsonSchemaJobTrackingConfig, optional) — Configuration for tracking jobs, including polling behavior and timeouts.
- `agent` (string, optional)
- `ontologyActionUrl` (string, optional, nullable)

## Response

### 201

Default Response

- `clientApplicationExtractorId` (string, optional)
- `clientApplicationId` (string, optional)
- `extractionUrl` (string, optional)
- `pollingUrl` (string, optional, nullable)
- `jobTrackingConfig` (V1ClientApplicationClientApplicationIdExtractorsPostResponsesContentApplicationJsonSchemaJobTrackingConfig, optional) — Configuration for tracking jobs, including polling behavior and timeouts.
- `agent` (string, optional)
- `ontologyActionUrl` (string, optional, nullable)
- `extractorType` (V1ClientApplicationClientApplicationIdExtractorsPostResponsesContentApplicationJsonSchemaExtractorType, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `type` (string, optional)
- `title` (string, optional)
- `status` (enum, optional)
  - Allowed values: `400`
- `detail` (string, optional)
- `instance` (string, optional)

### 404 Not Found Error

Not Found - Client application ID not found

- `type` (string, optional)
- `title` (string, optional)
- `status` (enum, optional)
  - Allowed values: `500`
- `detail` (string, optional)
- `instance` (string, optional)

### 500 Internal Server Error

Internal Server Error - Unexpected server error

- `type` (string, optional)
- `title` (string, optional)
- `status` (enum, optional)
  - Allowed values: `500`
- `detail` (string, optional)
- `instance` (string, optional)

## Types

### V1ClientApplicationClientApplicationIdExtractorsPostRequestBodyContentApplicationJsonSchemaJobTrackingConfig

Configuration for tracking jobs, including polling behavior and timeouts.

- `maxPollingAttempts` (integer, optional) — Maximum number of polling attempts.
- `pollIntervalMs` (integer, optional) — Base interval between polling attempts in milliseconds.
- `maxDurationMs` (integer, optional) — Maximum job duration for polling in milliseconds.
- `maxDelayMs` (integer, optional) — Maximum delay between polling attempts in milliseconds (exponential backoff). Set to 0 to disable exponential backoff.

### V1ClientApplicationClientApplicationIdExtractorsPostResponsesContentApplicationJsonSchemaJobTrackingConfig

Configuration for tracking jobs, including polling behavior and timeouts.

- `maxPollingAttempts` (integer, optional) — Maximum number of polling attempts.
- `pollIntervalMs` (integer, optional) — Base interval between polling attempts in milliseconds.
- `maxDurationMs` (integer, optional) — Maximum job duration for polling in milliseconds.
- `maxDelayMs` (integer, optional) — Maximum delay between polling attempts in milliseconds (exponential backoff). Set to 0 to disable exponential backoff.

### V1ClientApplicationClientApplicationIdExtractorsPostResponsesContentApplicationJsonSchemaExtractorType

- `extractorTypeId` (string, required)
- `extractorCode` (string, required)
- `name` (string, required)

## Examples

**Request**

```json
{
  "extractionUrl": "string",
  "apiKey": "string",
  "pollingUrl": "string",
  "extractorTypeId": "string"
}
```

**Response**

```json
{
  "clientApplicationExtractorId": "string",
  "clientApplicationId": "string",
  "extractionUrl": "string",
  "pollingUrl": "string",
  "jobTrackingConfig": {
    "maxPollingAttempts": 1,
    "pollIntervalMs": 1,
    "maxDurationMs": 1,
    "maxDelayMs": 1
  },
  "agent": "string",
  "ontologyActionUrl": "string",
  "extractorType": {
    "extractorTypeId": "string",
    "extractorCode": "string",
    "name": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "http://localhost:3200/v1/clientApplication/clientApplicationId/extractors"

payload = {
    "extractionUrl": "string",
    "apiKey": "string",
    "pollingUrl": "string",
    "extractorTypeId": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'http://localhost:3200/v1/clientApplication/clientApplicationId/extractors';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"extractionUrl":"string","apiKey":"string","pollingUrl":"string","extractorTypeId":"string"}'
};

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 := "http://localhost:3200/v1/clientApplication/clientApplicationId/extractors"

	payload := strings.NewReader("{\n  \"extractionUrl\": \"string\",\n  \"apiKey\": \"string\",\n  \"pollingUrl\": \"string\",\n  \"extractorTypeId\": \"string\"\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("http://localhost:3200/v1/clientApplication/clientApplicationId/extractors")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"extractionUrl\": \"string\",\n  \"apiKey\": \"string\",\n  \"pollingUrl\": \"string\",\n  \"extractorTypeId\": \"string\"\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("http://localhost:3200/v1/clientApplication/clientApplicationId/extractors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"extractionUrl\": \"string\",\n  \"apiKey\": \"string\",\n  \"pollingUrl\": \"string\",\n  \"extractorTypeId\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:3200/v1/clientApplication/clientApplicationId/extractors', [
  'body' => '{
  "extractionUrl": "string",
  "apiKey": "string",
  "pollingUrl": "string",
  "extractorTypeId": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:3200/v1/clientApplication/clientApplicationId/extractors");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"extractionUrl\": \"string\",\n  \"apiKey\": \"string\",\n  \"pollingUrl\": \"string\",\n  \"extractorTypeId\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:3200/v1/clientApplication/clientApplicationId/extractors")! 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()
```