Skip to main content
POST
/
v1
/
config_flow
/
start
Start a Config Flow
curl --request POST \
  --url http://0.0.0.0:3000/v1/config_flow/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "handler": "tuya"
}
'
import requests

url = "http://0.0.0.0:3000/v1/config_flow/start"

payload = { "handler": "tuya" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({handler: 'tuya'})
};

fetch('http://0.0.0.0:3000/v1/config_flow/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://0.0.0.0:3000/v1/config_flow/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'handler' => 'tuya'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "http://0.0.0.0:3000/v1/config_flow/start"

payload := strings.NewReader("{\n \"handler\": \"tuya\"\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(string(body))

}
HttpResponse<String> response = Unirest.post("http://0.0.0.0:3000/v1/config_flow/start")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"handler\": \"tuya\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://0.0.0.0:3000/v1/config_flow/start")

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 \"handler\": \"tuya\"\n}"

response = http.request(request)
puts response.read_body
{
  "type": "form",
  "flowId": "flow_abc123",
  "handler": "tuya",
  "stepId": "user",
  "data_schema": [
    {
      "name": "region",
      "type": "string"
    }
  ]
}
{
"message": "validation error"
}
{
"error": "unauthorized"
}
{
"message": "not found"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
handler
string
required

Nome da integração (ex: tuya, mqtt, knx)

Example:

"tuya"

Response

Config flow started

type
string

Tipo do passo atual (ex: form, external, abort, create_entry)

flowId
string
handler
string
stepId
string
errors
object | null
data_schema
any[] | null
url
string | null

URL OAuth2 para redirecionamento externo