# Atomic protocol step

POST https://api.forboc.ai/npcs/{npcId}/process
Content-Type: application/json

SDK sends the full accumulated tape and the result of the previous atomic side-effect.
API returns the next atomic instruction and the updated tape.


Reference: https://docs.forboc.ai/api-reference/endpoints/forboc-ai-sdk-api/np-cs/process-npc-step

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: ForbocAI API
  version: 1.0.0
paths:
  /npcs/{npcId}/process:
    post:
      operationId: process-npc-step
      summary: Atomic protocol step
      description: >
        SDK sends the full accumulated tape and the result of the previous
        atomic side-effect.

        API returns the next atomic instruction and the updated tape.
      tags:
        - subpackage_npCs
      parameters:
        - name: npcId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Next atomic instruction with updated tape
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NPCProcessResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NPCProcessRequest'
servers:
  - url: https://api.forboc.ai
  - url: http://localhost:8080
components:
  schemas:
    NPC:
      type: object
      properties:
        npcId:
          type: string
        persona:
          type: string
        data:
          type: object
          additionalProperties:
            description: Any type
      title: NPC
    RecalledMemoryType:
      type: string
      enum:
        - observation
        - experience
        - knowledge
        - emotion
      title: RecalledMemoryType
    RecalledMemory:
      type: object
      properties:
        text:
          type: string
        type:
          $ref: '#/components/schemas/RecalledMemoryType'
        importance:
          type: number
          format: double
        similarity:
          type:
            - number
            - 'null'
          format: double
      title: RecalledMemory
    PromptConstraints:
      type: object
      properties:
        maxTokens:
          type:
            - integer
            - 'null'
        temperature:
          type:
            - number
            - 'null'
          format: double
        stop:
          type:
            - array
            - 'null'
          items:
            type: string
      title: PromptConstraints
    NPCProcessTape:
      type: object
      properties:
        observation:
          type: string
        context:
          type: object
          additionalProperties:
            description: Any type
        npcState:
          type: object
          additionalProperties:
            description: Any type
        persona:
          type:
            - string
            - 'null'
        actor:
          oneOf:
            - $ref: '#/components/schemas/NPC'
            - type: 'null'
        memories:
          type: array
          items:
            $ref: '#/components/schemas/RecalledMemory'
        prompt:
          type:
            - string
            - 'null'
        constraints:
          oneOf:
            - $ref: '#/components/schemas/PromptConstraints'
            - type: 'null'
        generatedOutput:
          type:
            - string
            - 'null'
        rulesetId:
          type:
            - string
            - 'null'
        vectorQueried:
          type:
            - boolean
            - 'null'
      required:
        - observation
        - npcState
        - memories
      title: NPCProcessTape
    NPCProcessRequest:
      type: object
      properties:
        tape:
          $ref: '#/components/schemas/NPCProcessTape'
        lastResult:
          type:
            - object
            - 'null'
          additionalProperties:
            description: Any type
      required:
        - tape
      title: NPCProcessRequest
    IdentifyActorInstructionType:
      type: string
      enum:
        - IdentifyActor
      title: IdentifyActorInstructionType
    IdentifyActorInstruction:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/IdentifyActorInstructionType'
      title: IdentifyActorInstruction
    QueryVectorInstructionType:
      type: string
      enum:
        - QueryVector
      title: QueryVectorInstructionType
    QueryVectorInstruction:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/QueryVectorInstructionType'
        query:
          type: string
        limit:
          type: integer
        threshold:
          type: number
          format: double
      required:
        - type
        - query
        - limit
        - threshold
      title: QueryVectorInstruction
    ExecuteInferenceInstructionType:
      type: string
      enum:
        - ExecuteInference
      title: ExecuteInferenceInstructionType
    ExecuteInferenceInstruction:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ExecuteInferenceInstructionType'
        prompt:
          type: string
        constraints:
          $ref: '#/components/schemas/PromptConstraints'
      required:
        - type
        - prompt
        - constraints
      title: ExecuteInferenceInstruction
    FinalizeInstructionType:
      type: string
      enum:
        - Finalize
      title: FinalizeInstructionType
    MemoryStoreInstructionType:
      type: string
      enum:
        - observation
        - experience
        - knowledge
        - emotion
      title: MemoryStoreInstructionType
    MemoryStoreInstruction:
      type: object
      properties:
        text:
          type: string
        type:
          $ref: '#/components/schemas/MemoryStoreInstructionType'
        importance:
          type: number
          format: double
      title: MemoryStoreInstruction
    GenericAction:
      type: object
      properties:
        type:
          type: string
        reason:
          type:
            - string
            - 'null'
        target:
          type:
            - string
            - 'null'
      title: GenericAction
    FinalizeInstruction:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FinalizeInstructionType'
        valid:
          type: boolean
        signature:
          type:
            - string
            - 'null'
        memoryStore:
          type: array
          items:
            $ref: '#/components/schemas/MemoryStoreInstruction'
        stateTransform:
          type: object
          additionalProperties:
            description: Any type
        action:
          oneOf:
            - $ref: '#/components/schemas/GenericAction'
            - type: 'null'
        dialogue:
          type: string
      required:
        - type
        - valid
        - memoryStore
        - stateTransform
        - dialogue
      title: FinalizeInstruction
    NPCInstruction:
      oneOf:
        - $ref: '#/components/schemas/IdentifyActorInstruction'
        - $ref: '#/components/schemas/QueryVectorInstruction'
        - $ref: '#/components/schemas/ExecuteInferenceInstruction'
        - $ref: '#/components/schemas/FinalizeInstruction'
      title: NPCInstruction
    NPCProcessResponse:
      type: object
      properties:
        instruction:
          $ref: '#/components/schemas/NPCInstruction'
        tape:
          $ref: '#/components/schemas/NPCProcessTape'
      required:
        - instruction
        - tape
      title: NPCProcessResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

```

## SDK Code Examples

```python
import requests

url = "https://api.forboc.ai/npcs/npcId/process"

payload = { "tape": {
        "observation": "The NPC notices a suspicious figure lurking near the marketplace.",
        "npcState": {},
        "memories": [{}]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.forboc.ai/npcs/npcId/process';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"tape":{"observation":"The NPC notices a suspicious figure lurking near the marketplace.","npcState":{},"memories":[{}]}}'
};

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.forboc.ai/npcs/npcId/process"

	payload := strings.NewReader("{\n  \"tape\": {\n    \"observation\": \"The NPC notices a suspicious figure lurking near the marketplace.\",\n    \"npcState\": {},\n    \"memories\": [\n      {}\n    ]\n  }\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.forboc.ai/npcs/npcId/process")

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  \"tape\": {\n    \"observation\": \"The NPC notices a suspicious figure lurking near the marketplace.\",\n    \"npcState\": {},\n    \"memories\": [\n      {}\n    ]\n  }\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.forboc.ai/npcs/npcId/process")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tape\": {\n    \"observation\": \"The NPC notices a suspicious figure lurking near the marketplace.\",\n    \"npcState\": {},\n    \"memories\": [\n      {}\n    ]\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.forboc.ai/npcs/npcId/process', [
  'body' => '{
  "tape": {
    "observation": "The NPC notices a suspicious figure lurking near the marketplace.",
    "npcState": {},
    "memories": [
      {}
    ]
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.forboc.ai/npcs/npcId/process");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"tape\": {\n    \"observation\": \"The NPC notices a suspicious figure lurking near the marketplace.\",\n    \"npcState\": {},\n    \"memories\": [\n      {}\n    ]\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["tape": [
    "observation": "The NPC notices a suspicious figure lurking near the marketplace.",
    "npcState": [],
    "memories": [[]]
  ]] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.forboc.ai/npcs/npcId/process")! 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()
```