> ## Documentation Index > Fetch the complete documentation index at: https://docs.formal.ai/llms.txt > Use this file to discover all available pages before exploring further. # CreateForm > Form CRUD operations ## OpenAPI ````yaml /docs/api/openapi/workflow_openapi.json post /core.v1.WorkflowService/CreateForm openapi: 3.1.0 info: title: core.v1.WorkflowService version: 0.0.1 servers: - url: https://api.joinformal.com description: Production API security: [] tags: - name: core.v1.WorkflowService paths: /core.v1.WorkflowService/CreateForm: post: tags: - core.v1.WorkflowService summary: CreateForm description: Form CRUD operations operationId: core.v1.WorkflowService.CreateForm requestBody: content: application/json: schema: $ref: '#/components/schemas/core.v1.CreateFormRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/core.v1.CreateFormResponse' '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: code: type: string example: invalid_request message: type: string example: Invalid request parameters details: type: object '401': description: Unauthorized - Missing or invalid authentication content: application/json: schema: type: object properties: code: type: string example: unauthorized message: type: string example: Authentication required '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: code: type: string example: forbidden message: type: string example: Insufficient permissions to perform this action '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: code: type: string example: not_found message: type: string example: Resource not found '500': description: Internal Server Error - An error occurred processing the request content: application/json: schema: type: object properties: code: type: string example: internal_error message: type: string example: An internal error occurred security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: cURL source: >- curl -X POST "https://api.joinformal.com/core.v1.WorkflowService/CreateForm" \ -H "X-API-KEY: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "example": "value" }' - lang: javascript label: JavaScript (fetch) source: >- fetch("https://api.joinformal.com/core.v1.WorkflowService/CreateForm", { method: "POST", headers: { "X-API-KEY": "YOUR_API_KEY", "Content-Type": "application/json" }, body: JSON.stringify({ example: "value" }) }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error(error)); - lang: python label: Python source: >- import requests url = "https://api.joinformal.com/core.v1.WorkflowService/CreateForm" headers = { "X-API-KEY": "YOUR_API_KEY", "Content-Type": "application/json" } data = { "example": "value" } response = requests.post(url, headers=headers, json=data) print(response.json()) - lang: go label: Go source: |- package main import ( "bytes" "encoding/json" "fmt" "io" "net/http" ) func main() { url := "https://api.joinformal.com/core.v1.WorkflowService/CreateForm" body := map[string]string{ "example": "value", } jsonData, _ := json.Marshal(body) req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData)) req.Header.Set("X-API-KEY", "YOUR_API_KEY") req.Header.Set("Content-Type", "application/json") client := &http.Client{} resp, err := client.Do(req) if err != nil { panic(err) } defer resp.Body.Close() responseBody, _ := io.ReadAll(resp.Body) fmt.Println(string(responseBody)) } components: schemas: core.v1.CreateFormRequest: type: object properties: name: type: string title: name minLength: 1 description: type: string title: description fields: type: array items: $ref: '#/components/schemas/core.v1.FormField' title: fields title: CreateFormRequest additionalProperties: false core.v1.CreateFormResponse: type: object properties: form: $ref: '#/components/schemas/core.v1.Form' title: form title: CreateFormResponse additionalProperties: false core.v1.FormField: type: object properties: id: type: string title: id pattern: ^field_[_a-zA-Z0-9]+$ description: Unique ID for the field, must match pattern field_[a-zA-Z0-9]+ name: type: string title: name minLength: 1 type: type: string title: type minLength: 1 description: >- Type of form field: "string", "number", "timestamp", "email", "url", "date", "time", "select", "multi_select", "checkbox", "radio" config: $ref: '#/components/schemas/core.v1.FormFieldConfig' title: config description: Optional configuration for select/multi_select/checkbox/radio fields title: FormField additionalProperties: false core.v1.Form: type: object properties: id: type: string title: id minLength: 1 name: type: string title: name minLength: 1 description: type: string title: description fields: type: array items: $ref: '#/components/schemas/core.v1.FormField' title: fields createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: | timestamp.lt_now = true updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at description: | timestamp.lt_now = true title: Form additionalProperties: false core.v1.FormFieldConfig: type: object properties: options: type: array items: $ref: '#/components/schemas/core.v1.FormFieldOption' title: options description: 'For static select/multi_select/checkbox/radio: predefined options' optionsSource: $ref: '#/components/schemas/core.v1.FormFieldOptionsSource' title: options_source description: >- For dynamic options: API call configuration (mirrors formal-app-command schema) title: FormFieldConfig additionalProperties: false google.protobuf.Timestamp: type: string examples: - '2023-01-15T01:30:15.01Z' - '2024-12-25T12:00:00Z' format: date-time description: >- A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format. core.v1.FormFieldOption: type: object properties: label: type: string title: label minLength: 1 value: type: string title: value minLength: 1 title: FormFieldOption additionalProperties: false description: Form messages core.v1.FormFieldOptionsSource: type: object properties: app: type: string title: app minLength: 1 description: The app/service name (e.g., "Resources", "Policies") command: $ref: '#/components/schemas/core.v1.FormFieldOptionsSourceCommand' title: command description: The command to execute machineUserId: type: string title: machine_user_id minLength: 1 description: The machine user whose temporary API key will authenticate the call input: $ref: '#/components/schemas/google.protobuf.Struct' title: input description: >- Input payload for the API call (supports ${{ query }} interpolation for search text) transform: type: string title: transform minLength: 1 description: >- CEL expression to transform the API response into [{value, text}] options title: FormFieldOptionsSource additionalProperties: false core.v1.FormFieldOptionsSourceCommand: type: object properties: name: type: string title: name minLength: 1 title: FormFieldOptionsSourceCommand additionalProperties: false google.protobuf.Struct: type: object additionalProperties: $ref: '#/components/schemas/google.protobuf.Value' description: |- `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. The JSON representation for `Struct` is JSON object. google.protobuf.Value: oneOf: - type: 'null' - type: number - type: string - type: boolean - type: array - type: object additionalProperties: true description: |- `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for `Value` is JSON value. securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: API key authentication. Get your API key from the Formal console. ````