├── .github └── workflows │ └── release.yml ├── .gitignore ├── LICENSE ├── README.md ├── go.mod ├── go.sum └── main.go /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Create release on new tag 2 | 3 | on: 4 | push: 5 | tags: 6 | - "v*" 7 | 8 | jobs: 9 | build: 10 | name: Create release 11 | runs-on: ubuntu-latest 12 | permissions: 13 | contents: write 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v4 17 | - name: Get tag name 18 | run: echo "REPO_TAG=$(echo "${{ github.ref_name }}" | sed 's/^v//')" >> $GITHUB_ENV 19 | - name: Setup Go 20 | uses: actions/setup-go@v5 21 | with: 22 | go-version: "stable" 23 | - name: Get Go dependencies 24 | run: go get 25 | - name: Build Linux amd64 26 | run: | 27 | CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o grok3_api 28 | tar -czvf grok3_api-${{ env.REPO_TAG }}-linux-amd64.tar.gz grok3_api 29 | - name: Build Windows amd64 30 | run: | 31 | CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o grok3_api.exe 32 | tar -czvf grok3_api-${{ env.REPO_TAG }}-windows-amd64.tar.gz grok3_api.exe 33 | - name: Build Darwin amd64 34 | run: | 35 | CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -o grok3_api 36 | tar -czvf grok3_api-${{ env.REPO_TAG }}-darwin-amd64.tar.gz grok3_api 37 | - name: Build Darwin arm64 38 | run: | 39 | CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -o grok3_api 40 | tar -czvf grok3_api-${{ env.REPO_TAG }}-darwin-arm64.tar.gz grok3_api 41 | - name: Release artifacts 42 | uses: ncipollo/release-action@v1 43 | with: 44 | artifacts: "*.tar.gz" 45 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.json 2 | grok3_api 3 | *.exe 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Grok 3 Web API Wrapper 2 | 3 | This is a Go-based tool designed to interact with the Grok 3 Web API, offering an OpenAI-compatible API endpoint for chat completions. It enables users to send messages to the Grok 3 Web API and receive responses in a format consistent with OpenAI's chat completion API. 4 | 5 | ## Features 6 | 7 | - **OpenAI-Compatible Endpoint**: Supports `/v1/chat/completions` and `/v1/models` endpoints. 8 | - **Streaming Support**: Enables real-time streaming of responses. 9 | - **Model Selection**: Choose between standard and reasoning models. 10 | - **Cookie Management**: Manages multiple cookies. 11 | - **Proxy Support**: Compatible with HTTP and SOCKS5 proxies for network requests. 12 | - **Configurable Options**: Includes flags for retaining chat conversations, filtering thinking content, and adding custom text to prompts. 13 | 14 | ## Prerequisites 15 | 16 | Before you use this tool, ensure you have the following: 17 | 18 | - **Grok Cookie**: Obtain your account's cookie from [grok.com](https://grok.com) by your browser (such as `aaa=bbb; ccc=ddd`). 19 | - **API Authentication Token**: Prepare a token to secure the OpenAI-compatible API endpoints. 20 | 21 | ## Basic Usage 22 | 23 | The API authentication token is **required** while running this tool. The Grok cookie must be set by the `-cookie` flag, `-cookieFile` flag or the request body. 24 | 25 | Run this: 26 | 27 | ``` 28 | grok3_api -token your_secret_token 29 | ``` 30 | 31 | Then the OpenAI-compatible API endpoints can be accessed through `http://localhost:8180/v1`. 32 | 33 | ## Configuration 34 | 35 | You can configure this tool using command-line flags, environment variables or the request body. 36 | 37 | ### Command-Line Flags 38 | 39 | - `-token`: API authentication token (**required**). 40 | - `-cookie`: Grok cookie(s) for authentication. Accepts a single cookie or a JSON array of cookies. 41 | - `-cookieFile`: A text file which contains Grok cookies line by line. 42 | - `-textBeforePrompt`: Text to add before the user’s message. The default text can be viewed by using the `-help` flag. 43 | - `-textAfterPrompt`: Text to add after the user’s message (default: empty string). 44 | - `-keepChat`: Retains chat conversations after each request if set. 45 | - `-ignoreThinking`: Excludes thinking tokens from responses when using the reasoning model. 46 | - `-charsLimit`: Upload the message as a file if the count of its characters is greater than this limit (default: 50,000). 47 | - `-httpProxy`: Specifies an HTTP or SOCKS5 proxy URL. The proxy URL should be something like `http://127.0.0.1:1080` or `socks5://127.0.0.1:1080`. 48 | - `-port`: Sets the server port (default: 8180). 49 | - `-help`: Prints the help message. 50 | 51 | ### Environment Variables 52 | 53 | `GROK3_AUTH_TOKEN`: Alternative to the `-token` flag. 54 | 55 | `GROK3_COOKIE`: Alternative to the `-cookie` flag. 56 | 57 | `http_proxy`: Alternative to the `-httpProxy` flag. 58 | 59 | ### Request Body for Completion 60 | 61 | Some configurations can be set in the request body while using the `/v1/chat/completions` endpoint. 62 | 63 | Request body (JSON): 64 | 65 | ```json 66 | { 67 | "messages": [], 68 | "model": "grok-3", // "grok-3" for the standard Grok 3 model, "grok-3-reasoning" for the Grok 3 reasoning model. 69 | "stream": true, // true for streaming response. 70 | "grokCookies": ["cookie1", "cookie2"], // a string for a single cookie, or a list of strings for multiple cookies. 71 | "cookieIndex": 1, // the index of cookie (starting from 1) to request Grok 3 Web API. If the index is 0, auto selecting cookies in turn (defalut behaviour). 72 | "enableSearch": 1, // 1 to enable Web searching, 0 to disable (defalut behaviour). 73 | "uploadMessage": 1, // 1 to upload the message as a file (for very long message), 0 to only upload the message if the count of characters is greater than the count specified by `-charsLimit` (defalut behaviour). 74 | "textBeforePrompt": "System: You are a helpful assistant.", // text to add before the user’s message. The default text can be viewed by using the `-help` flag. 75 | "textAfterPrompt": "End of message.", // text to add after the user’s message (default: empty string). 76 | "keepChat": 1, // 1 to retain this chat conversation, 0 to not retain it (defalut behaviour). 77 | "ignoreThinking": 1 // 1 to exclude thinking tokens from the response when using the reasoning model, 0 to retain thinking tokens (defalut behaviour). 78 | } 79 | ``` 80 | 81 | ## Warnings 82 | 83 | This tool offers an unofficial OpenAI-compatible API of Grok 3, so your account may be **banned** by xAI if using this tool. 84 | 85 | Please do not abuse or use this tool for commercial purposes. Use it at your own risk. 86 | 87 | ## Special Thanks 88 | 89 | - [mem0ai/grok3-api: Unofficial Grok 3 API](https://github.com/mem0ai/grok3-api) 90 | - [RoCry/grok3-api-cf: Grok 3 via API with Cloudflare for free](https://github.com/RoCry/grok3-api-cf/tree/master) 91 | - Most code was written by Grok 3, thanks to Grok 3. 92 | 93 | ## License 94 | 95 | This project is licensed under the `AGPL-3.0` License. 96 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/orzogc/grok3_api 2 | 3 | go 1.24.0 4 | 5 | require github.com/google/uuid v1.6.0 6 | 7 | require github.com/andybalholm/brotli v1.1.1 8 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/andybalholm/brotli v1.1.1 h1:PR2pgnyFznKEugtsUo0xLdDop5SKXd5Qf5ysW+7XdTA= 2 | github.com/andybalholm/brotli v1.1.1/go.mod h1:05ib4cKhjx3OQYUY22hTVd34Bc8upXjOLL2rKwwZBoA= 3 | github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= 4 | github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 5 | github.com/xyproto/randomstring v1.0.5 h1:YtlWPoRdgMu3NZtP45drfy1GKoojuR7hmRcnhZqKjWU= 6 | github.com/xyproto/randomstring v1.0.5/go.mod h1:rgmS5DeNXLivK7YprL0pY+lTuhNQW3iGxZ18UQApw/E= 7 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "bytes" 6 | "compress/gzip" 7 | "encoding/base64" 8 | "encoding/json" 9 | "flag" 10 | "fmt" 11 | "io" 12 | "log" 13 | "net" 14 | "net/http" 15 | "net/url" 16 | "os" 17 | "strings" 18 | "sync" 19 | "time" 20 | "unicode/utf8" 21 | 22 | "github.com/andybalholm/brotli" 23 | "github.com/google/uuid" 24 | ) 25 | 26 | // GrokClient defines a client for interacting with the Grok 3 Web API. 27 | // It encapsulates the API endpoints, HTTP headers, and configuration flags. 28 | type GrokClient struct { 29 | headers map[string]string // HTTP headers for API requests 30 | isReasoning bool // Flag for using reasoning model 31 | enableSearch bool // Flag for searching in the Web 32 | uploadMessage bool // Flag for uploading the message as a file 33 | keepChat bool // Flag to preserve chat history 34 | ignoreThinking bool // Flag to exclude thinking tokens in responses 35 | } 36 | 37 | // NewGrokClient creates a new instance of GrokClient with the provided cookies and configuration flags. 38 | func NewGrokClient(cookie string, isReasoning bool, enableSearch bool, uploadMessage bool, keepChat bool, ignoreThinking bool) *GrokClient { 39 | return &GrokClient{ 40 | headers: map[string]string{ 41 | "accept": "*/*", 42 | "accept-encoding": "gzip, deflate, br, zstd", 43 | "accept-language": "en-US;q=0.9,en;q=0.8", 44 | "content-type": "application/json", 45 | "host": "grok.com", 46 | "origin": "https://grok.com", 47 | "dnt": "1", 48 | "priority": "u=1, i", 49 | "referer": "https://grok.com/", 50 | "sec-ch-ua": `"Not:A-Brand";v="24", "Chromium";v="134"`, 51 | "sec-ch-ua-mobile": "?0", 52 | "sec-ch-ua-platform": `"Linux"`, 53 | "sec-fetch-dest": "empty", 54 | "sec-fetch-mode": "cors", 55 | "sec-fetch-site": "same-origin", 56 | "user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36", 57 | "cookie": cookie, 58 | }, 59 | isReasoning: isReasoning, 60 | enableSearch: enableSearch, 61 | uploadMessage: uploadMessage, 62 | keepChat: keepChat, 63 | ignoreThinking: ignoreThinking, 64 | } 65 | } 66 | 67 | type ToolOverrides struct { 68 | ImageGen bool `json:"imageGen"` 69 | TrendsSearch bool `json:"trendsSearch"` 70 | WebSearch bool `json:"webSearch"` 71 | XMediaSearch bool `json:"xMediaSearch"` 72 | XPostAnalyze bool `json:"xPostAnalyze"` 73 | XSearch bool `json:"xSearch"` 74 | } 75 | 76 | // preparePayload constructs the request payload for the Grok 3 Web API based on the given message and reasoning flag. 77 | func (c *GrokClient) preparePayload(message string, fileId string) map[string]any { 78 | var toolOverrides any = ToolOverrides{} 79 | if c.enableSearch { 80 | toolOverrides = map[string]any{} 81 | } 82 | 83 | fileAttachments := []string{} 84 | if fileId != "" { 85 | fileAttachments = []string{fileId} 86 | } 87 | 88 | return map[string]any{ 89 | "disableSearch": false, 90 | "enableImageGeneration": true, 91 | "enableImageStreaming": true, 92 | "enableSideBySide": true, 93 | "fileAttachments": fileAttachments, 94 | "forceConcise": false, 95 | "imageAttachments": []string{}, 96 | "imageGenerationCount": 2, 97 | "isPreset": false, 98 | "isReasoning": c.isReasoning, 99 | "message": message, 100 | "modelName": "grok-3", 101 | "returnImageBytes": false, 102 | "returnRawGrokInXaiRequest": false, 103 | "sendFinalMetadata": true, 104 | "temporary": !c.keepChat, 105 | "toolOverrides": toolOverrides, 106 | "webpageUrls": []string{}, 107 | } 108 | } 109 | 110 | // getModelName returns the appropriate model name based on the isReasoning flag. 111 | func (c *GrokClient) getModelName() string { 112 | if c.isReasoning { 113 | return grok3ReasoningModelName 114 | } else { 115 | return grok3ModelName 116 | } 117 | } 118 | 119 | // RequestBody represents the structure of the JSON body expected in POST requests to the /v1/chat/completions endpoint, 120 | // following the OpenAI API format. It includes fields for model selection, messages, streaming option, and additional specific options. 121 | type RequestBody struct { 122 | Model string `json:"model"` 123 | Messages []struct { 124 | Role string `json:"role"` 125 | Content any `json:"content"` 126 | } `json:"messages"` 127 | Stream bool `json:"stream"` 128 | GrokCookies any `json:"grokCookies,omitempty"` // A single cookie(string), or a list of cookie([]string) 129 | CookieIndex uint `json:"cookieIndex,omitempty"` // Start from 1, 0 means auto-select cookies in turn 130 | EnableSearch int `json:"enableSearch,omitempty"` // > 0 is true, == 0 is false 131 | UploadMessage int `json:"uploadMessage,omitempty"` // > 0 is true, == 0 is false 132 | TextBeforePrompt string `json:"textBeforePrompt,omitempty"` 133 | TextAfterPrompt string `json:"textAfterPrompt,omitempty"` 134 | KeepChat int `json:"keepChat,omitempty"` // > 0 is true, == 0 is false 135 | IgnoreThinking int `json:"ignoreThinking,omitempty"` // > 0 is true, == 0 is false 136 | } 137 | 138 | // ResponseToken represents a single token response from the Grok 3 Web API. 139 | type ResponseToken struct { 140 | Result struct { 141 | Response struct { 142 | Token string `json:"token"` 143 | IsThinking bool `json:"isThinking"` 144 | } `json:"response"` 145 | } `json:"result"` 146 | } 147 | 148 | // ModelData represents model metadata for OpenAI-compatible response. 149 | type ModelData struct { 150 | Id string `json:"id"` 151 | Object string `json:"object"` 152 | Owned_by string `json:"owned_by"` 153 | } 154 | 155 | // ModelList contains available models for OpenAI-compatible endpoint. 156 | type ModelList struct { 157 | Object string `json:"object"` 158 | Data []ModelData `json:"data"` 159 | } 160 | 161 | // UploadFileRequest represents the request for uploading a file. 162 | type UploadFileRequest struct { 163 | Content string `json:"content"` 164 | FileMimeType string `json:"fileMimeType"` 165 | FileName string `json:"fileName"` 166 | } 167 | 168 | // UploadFileResponse represents the response for uploading a file. 169 | type UploadFileResponse struct { 170 | FileMetadataId string `json:"fileMetadataId"` 171 | } 172 | 173 | const ( 174 | newChatUrl = "https://grok.com/rest/app-chat/conversations/new" // Endpoint for creating new conversations 175 | uploadFileUrl = "https://grok.com/rest/app-chat/upload-file" // Endpoint for uploading files 176 | 177 | grok3ModelName = "grok-3" 178 | grok3ReasoningModelName = "grok-3-reasoning" 179 | 180 | completionsPath = "/v1/chat/completions" 181 | listModelsPath = "/v1/models" 182 | 183 | messageCharsLimit = 50000 184 | 185 | defaultBeforePromptText = "For the data below, entries with '[[system]]' are system information, entries with '[[assistant]]' are messages you have previously sent, entries with '[[user]]' are messages sent by the user. You need to respond to the user's last message accordingly based on the corresponding data." 186 | defaultUploadMessagePrompt = "Follow the instructions in the attached file to respond." 187 | ) 188 | 189 | // Global configuration variables set. 190 | var ( 191 | apiToken *string 192 | grokCookies []string 193 | textBeforePrompt *string 194 | textAfterPrompt *string 195 | keepChat *bool 196 | ignoreThinking *bool 197 | charsLimit *uint 198 | httpProxy *string 199 | httpClient = &http.Client{Timeout: 30 * time.Minute} 200 | nextCookieIndex = struct { // Thread-safe cookie rotation 201 | sync.Mutex 202 | index uint // Start from 0 203 | }{} 204 | ) 205 | 206 | // decompressBody decompresses the response body. 207 | func decompressBody(resp *http.Response) (io.ReadCloser, error) { 208 | switch resp.Header.Get("content-encoding") { 209 | case "br": 210 | return io.NopCloser(brotli.NewReader(resp.Body)), nil 211 | case "gzip": 212 | return gzip.NewReader(resp.Body) 213 | case "": 214 | return resp.Body, nil 215 | default: 216 | return nil, fmt.Errorf("unknown response encoding: %s", resp.Header.Get("content-encoding")) 217 | } 218 | 219 | } 220 | 221 | // doRequest sends the HTTP request. 222 | func (c *GrokClient) doRequest(method string, url string, payload any) (*http.Response, error) { 223 | jsonPayload, err := json.Marshal(payload) 224 | if err != nil { 225 | return nil, fmt.Errorf("failed to marshal payload: %v", err) 226 | } 227 | 228 | req, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload)) 229 | if err != nil { 230 | return nil, fmt.Errorf("failed to create request: %v", err) 231 | } 232 | 233 | for key, value := range c.headers { 234 | req.Header.Set(key, value) 235 | } 236 | 237 | resp, err := httpClient.Do(req) 238 | if err != nil { 239 | return nil, fmt.Errorf("failed to send request: %v", err) 240 | } 241 | if resp.StatusCode != http.StatusOK { 242 | defer resp.Body.Close() 243 | respBody, err := decompressBody(resp) 244 | if err != nil { 245 | return nil, err 246 | } 247 | defer respBody.Close() 248 | body, err := io.ReadAll(respBody) 249 | if err != nil { 250 | return nil, fmt.Errorf("the Grok API error: %s", resp.Status) 251 | } 252 | return nil, fmt.Errorf("the Grok API error: %s, response body: %s", resp.Status, string(body)[:min(len(body), 128)]) 253 | } 254 | 255 | return resp, nil 256 | } 257 | 258 | func (c *GrokClient) uploadMessageAsFile(message string) (*UploadFileResponse, error) { 259 | content := base64.StdEncoding.EncodeToString([]byte(message)) 260 | payload := UploadFileRequest{ 261 | Content: content, 262 | FileMimeType: "text/plain", 263 | FileName: uuid.New().String() + ".txt", 264 | } 265 | log.Println("Uploading the message as a file") 266 | resp, err := c.doRequest(http.MethodPost, uploadFileUrl, payload) 267 | if err != nil { 268 | return nil, err 269 | } 270 | defer resp.Body.Close() 271 | respBody, err := decompressBody(resp) 272 | if err != nil { 273 | return nil, err 274 | } 275 | defer respBody.Close() 276 | body, err := io.ReadAll(respBody) 277 | if err != nil { 278 | return nil, fmt.Errorf("uploading file error: %d %s", resp.StatusCode, resp.Status) 279 | } 280 | response := &UploadFileResponse{} 281 | err = json.Unmarshal(body, response) 282 | if err != nil { 283 | return nil, fmt.Errorf("parsing json error: %s", string(body)) 284 | } 285 | if response.FileMetadataId == "" { 286 | return nil, fmt.Errorf("uploading file error: empty `FileMetadataId`") 287 | } 288 | 289 | return response, nil 290 | } 291 | 292 | // sendMessage sends a message to the Grok 3 Web API and returns the response body as an io.ReadCloser. 293 | // If stream is true, it returns the streaming response; otherwise, it reads the entire response. 294 | func (c *GrokClient) sendMessage(message string) (*http.Response, error) { 295 | fileId := "" 296 | if c.uploadMessage || (len(message) > int(*charsLimit) && utf8.RuneCountInString(message) > int(*charsLimit)) { 297 | uploadResp, err := c.uploadMessageAsFile(message) 298 | if err != nil { 299 | return nil, err 300 | } 301 | fileId = uploadResp.FileMetadataId 302 | message = defaultUploadMessagePrompt 303 | } 304 | 305 | payload := c.preparePayload(message, fileId) 306 | resp, err := c.doRequest(http.MethodPost, newChatUrl, payload) 307 | if err != nil { 308 | return nil, err 309 | } 310 | 311 | return resp, nil 312 | } 313 | 314 | type OpenAIChatCompletionMessage struct { 315 | Role string `json:"role"` 316 | Content string `json:"content"` 317 | } 318 | 319 | type OpenAIChatCompletionChunkChoice struct { 320 | Index int `json:"index"` 321 | Delta OpenAIChatCompletionMessage `json:"delta"` 322 | FinishReason string `json:"finish_reason"` 323 | } 324 | 325 | // OpenAIChatCompletionChunk represents the streaming response format for OpenAI. 326 | type OpenAIChatCompletionChunk struct { 327 | ID string `json:"id"` 328 | Object string `json:"object"` 329 | Created int64 `json:"created"` 330 | Model string `json:"model"` 331 | Choices []OpenAIChatCompletionChunkChoice `json:"choices"` 332 | } 333 | 334 | type OpenAIChatCompletionChoice struct { 335 | Index int `json:"index"` 336 | Message OpenAIChatCompletionMessage `json:"message"` 337 | FinishReason string `json:"finish_reason"` 338 | } 339 | 340 | type OpenAIChatCompletionUsage struct { 341 | PromptTokens int `json:"prompt_tokens"` 342 | CompletionTokens int `json:"completion_tokens"` 343 | TotalTokens int `json:"total_tokens"` 344 | } 345 | 346 | // OpenAIChatCompletion represents the non-streaming response format for OpenAI. 347 | type OpenAIChatCompletion struct { 348 | ID string `json:"id"` 349 | Object string `json:"object"` 350 | Created int64 `json:"created"` 351 | Model string `json:"model"` 352 | Choices []OpenAIChatCompletionChoice `json:"choices"` 353 | Usage OpenAIChatCompletionUsage `json:"usage"` 354 | } 355 | 356 | // parseGrok3StreamingJson parses the streaming response from Grok 3. 357 | func (c *GrokClient) parseGrok3StreamingJson(stream io.Reader, handler func(respToken string)) { 358 | // Read and process the streaming response from Grok 3 359 | isThinking := false 360 | decoder := json.NewDecoder(stream) 361 | for { 362 | var token ResponseToken 363 | err := decoder.Decode(&token) 364 | if err == io.EOF { 365 | break 366 | } else if err != nil { 367 | log.Printf("Parsing json error: %v", err) 368 | break 369 | } 370 | 371 | respToken := token.Result.Response.Token 372 | // Handle thinking tokens based on configuration 373 | if c.ignoreThinking && token.Result.Response.IsThinking { 374 | continue 375 | } else if token.Result.Response.IsThinking { 376 | if !isThinking { 377 | respToken = "\n" + respToken 378 | } 379 | isThinking = true 380 | } else if isThinking { 381 | respToken = respToken + "\n\n\n" 382 | isThinking = false 383 | } 384 | 385 | if respToken != "" { 386 | handler(respToken) 387 | } 388 | } 389 | } 390 | 391 | // createOpenAIStreamingResponse returns an HTTP handler that converts the Grok 3 streaming response to OpenAI's streaming format 392 | // and writes it to the response writer. 393 | func (c *GrokClient) createOpenAIStreamingResponse(grokStream io.Reader) http.HandlerFunc { 394 | return func(w http.ResponseWriter, r *http.Request) { 395 | // Set up headers for streaming response 396 | w.Header().Set("Content-Type", "text/event-stream") 397 | w.Header().Set("Cache-Control", "no-cache") 398 | w.Header().Set("Connection", "keep-alive") 399 | 400 | flusher, ok := w.(http.Flusher) 401 | if !ok { 402 | http.Error(w, logPrintf("Streaming unsupported"), http.StatusInternalServerError) 403 | return 404 | } 405 | 406 | completionID := "chatcmpl-" + uuid.New().String() 407 | 408 | // Create and send the initial chunk 409 | startChunk := OpenAIChatCompletionChunk{ 410 | ID: completionID, 411 | Object: "chat.completion.chunk", 412 | Created: time.Now().Unix(), 413 | Model: c.getModelName(), 414 | Choices: []OpenAIChatCompletionChunkChoice{ 415 | { 416 | Index: 0, 417 | Delta: OpenAIChatCompletionMessage{ 418 | Role: "assistant", 419 | }, 420 | FinishReason: "", 421 | }, 422 | }, 423 | } 424 | fmt.Fprintf(w, "data: %s\n\n", mustMarshal(startChunk)) 425 | flusher.Flush() 426 | 427 | c.parseGrok3StreamingJson(grokStream, func(respToken string) { 428 | // Send token as a chunk in OpenAI format 429 | chunk := OpenAIChatCompletionChunk{ 430 | ID: completionID, 431 | Object: "chat.completion.chunk", 432 | Created: time.Now().Unix(), 433 | Model: c.getModelName(), 434 | Choices: []OpenAIChatCompletionChunkChoice{ 435 | { 436 | Index: 0, 437 | Delta: OpenAIChatCompletionMessage{ 438 | Content: respToken, 439 | }, 440 | FinishReason: "", 441 | }, 442 | }, 443 | } 444 | fmt.Fprintf(w, "data: %s\n\n", mustMarshal(chunk)) 445 | flusher.Flush() 446 | }) 447 | 448 | // Send the final chunk after streaming ends 449 | finalChunk := OpenAIChatCompletionChunk{ 450 | ID: completionID, 451 | Object: "chat.completion.chunk", 452 | Created: time.Now().Unix(), 453 | Model: c.getModelName(), 454 | Choices: []OpenAIChatCompletionChunkChoice{ 455 | { 456 | Index: 0, 457 | Delta: OpenAIChatCompletionMessage{}, 458 | FinishReason: "stop", 459 | }, 460 | }, 461 | } 462 | fmt.Fprintf(w, "data: %s\n\n", mustMarshal(finalChunk)) 463 | flusher.Flush() 464 | 465 | // Finish the stream 466 | fmt.Fprintf(w, "data: [DONE]\n\n") 467 | flusher.Flush() 468 | 469 | } 470 | } 471 | 472 | // createOpenAIFullResponse returns an HTTP handler that reads the full Grok 3 response, converts it to OpenAI's format, 473 | // and writes it to the response writer. 474 | func (c *GrokClient) createOpenAIFullResponse(grokFull io.Reader) http.HandlerFunc { 475 | return func(w http.ResponseWriter, r *http.Request) { 476 | var fullResponse strings.Builder 477 | c.parseGrok3StreamingJson(grokFull, func(respToken string) { 478 | fullResponse.WriteString(respToken) 479 | }) 480 | 481 | openAIResponse := c.createOpenAIFullResponseBody(fullResponse.String()) 482 | w.Header().Set("Content-Type", "application/json") 483 | if err := json.NewEncoder(w).Encode(openAIResponse); err != nil { 484 | http.Error(w, logPrintf("Encoding response error: %v", err), http.StatusInternalServerError) 485 | return 486 | } 487 | } 488 | } 489 | 490 | // createOpenAIFullResponseBody creates the OpenAI response body for non-streaming requests. 491 | func (c *GrokClient) createOpenAIFullResponseBody(content string) OpenAIChatCompletion { 492 | return OpenAIChatCompletion{ 493 | ID: "chatcmpl-" + uuid.New().String(), 494 | Object: "chat.completion", 495 | Created: time.Now().Unix(), 496 | Model: c.getModelName(), 497 | Choices: []OpenAIChatCompletionChoice{ 498 | { 499 | Index: 0, 500 | Message: OpenAIChatCompletionMessage{ 501 | Role: "assistant", 502 | Content: content, 503 | }, 504 | FinishReason: "stop", 505 | }, 506 | }, 507 | Usage: OpenAIChatCompletionUsage{ 508 | PromptTokens: -1, 509 | CompletionTokens: -1, 510 | TotalTokens: -1, 511 | }, 512 | } 513 | } 514 | 515 | // mustMarshal serializes the given value to a JSON string, panicking on error. 516 | func mustMarshal(v any) string { 517 | b, err := json.Marshal(v) 518 | if err != nil { 519 | panic(err) 520 | } 521 | return string(b) 522 | } 523 | 524 | // logPrintf prints the message to the standard logger and returns the string. 525 | func logPrintf(format string, a ...any) string { 526 | log.Printf(format, a...) 527 | 528 | return fmt.Sprintf(format, a...) 529 | } 530 | 531 | // getCookieIndex selects the next cookie index in a round-robin fashion for load balancing or rotation. 532 | // If cookieIndex is 0 or out of range, it uses the next index in sequence (len must be > 0). 533 | func getCookieIndex(len int, cookieIndex uint) uint { 534 | if cookieIndex == 0 || cookieIndex > uint(len) { 535 | nextCookieIndex.Lock() 536 | defer nextCookieIndex.Unlock() 537 | index := nextCookieIndex.index 538 | nextCookieIndex.index = (nextCookieIndex.index + 1) % uint(len) 539 | 540 | return index % uint(len) 541 | } else { 542 | return cookieIndex - 1 543 | } 544 | } 545 | 546 | // handleChatCompletion handles incoming POST requests to /v1/chat/completions, authenticates the request, 547 | // parses the request body, interacts with the Grok 3 API, and sends the response in OpenAI's format. 548 | func handleChatCompletion(w http.ResponseWriter, r *http.Request) { 549 | // Log the request details 550 | log.Printf("Request from %s for %s", r.RemoteAddr, completionsPath) 551 | 552 | if r.URL.Path != completionsPath { 553 | http.Error(w, logPrintf("Requested Path %s Not Found", r.URL.Path), http.StatusNotFound) 554 | return 555 | } 556 | 557 | if r.Method != http.MethodPost { 558 | http.Error(w, logPrintf("Method %s Not Allowed", r.Method), http.StatusMethodNotAllowed) 559 | return 560 | } 561 | 562 | // Authenticate the request 563 | authHeader := r.Header.Get("Authorization") 564 | if authHeader == "" || !strings.HasPrefix(authHeader, "Bearer ") { 565 | http.Error(w, logPrintf("Unauthorized: Bearer token required"), http.StatusUnauthorized) 566 | return 567 | } 568 | 569 | token := strings.TrimSpace(strings.TrimPrefix(authHeader, "Bearer ")) 570 | if token != *apiToken { 571 | http.Error(w, logPrintf("Unauthorized: Invalid token"), http.StatusUnauthorized) 572 | return 573 | } 574 | 575 | // Parse the request body 576 | body := RequestBody{EnableSearch: -1, KeepChat: -1, IgnoreThinking: -1} 577 | if err := json.NewDecoder(r.Body).Decode(&body); err != nil { 578 | http.Error(w, logPrintf("Bad Request: Invalid JSON"), http.StatusBadRequest) 579 | return 580 | } 581 | 582 | // Select the appropriate cookie 583 | var cookie string 584 | var cookieIndex uint 585 | if body.GrokCookies != nil { 586 | if ck, ok := body.GrokCookies.(string); ok { 587 | cookie = ck 588 | } else if list, ok := body.GrokCookies.([]any); ok { 589 | if len(list) > 0 { 590 | cookieIndex = getCookieIndex(len(list), body.CookieIndex) 591 | if ck, ok := list[cookieIndex].(string); ok { 592 | cookie = ck 593 | } else { 594 | http.Error(w, logPrintf("Error: Invalid Grok 3 cookie"), http.StatusBadRequest) 595 | return 596 | } 597 | } 598 | } 599 | } 600 | cookie = strings.TrimSpace(cookie) 601 | if cookie == "" && len(grokCookies) > 0 { 602 | cookieIndex = getCookieIndex(len(grokCookies), body.CookieIndex) 603 | cookie = grokCookies[cookieIndex] 604 | } 605 | cookie = strings.TrimSpace(cookie) 606 | if cookie == "" { 607 | http.Error(w, logPrintf("Error: No Grok 3 cookie"), http.StatusBadRequest) 608 | return 609 | } 610 | 611 | messages := body.Messages 612 | if len(messages) == 0 { 613 | http.Error(w, logPrintf("Bad Request: No messages provided"), http.StatusBadRequest) 614 | return 615 | } 616 | 617 | var beforePromptText string 618 | var afterPromptText string 619 | if body.TextBeforePrompt != "" { 620 | beforePromptText = body.TextBeforePrompt 621 | } else { 622 | beforePromptText = *textBeforePrompt 623 | } 624 | if body.TextAfterPrompt != "" { 625 | afterPromptText = body.TextAfterPrompt 626 | } else { 627 | afterPromptText = *textAfterPrompt 628 | } 629 | 630 | // Construct the message to send to Grok 3 631 | var messageBuilder strings.Builder 632 | fmt.Fprintln(&messageBuilder, beforePromptText) 633 | for _, msg := range messages { 634 | fmt.Fprintf(&messageBuilder, "\n[[%s]]\n", msg.Role) 635 | if content, ok := msg.Content.(string); ok { 636 | messageBuilder.WriteString(content) 637 | } else if messages, ok := msg.Content.([]any); ok && msg.Role == "user" { 638 | for _, message := range messages { 639 | if text, ok := message.(map[string]any); ok { 640 | messageType := text["type"] 641 | if ty, ok := messageType.(string); ok && ty == "text" { 642 | if t, ok := text["text"].(string); ok { 643 | fmt.Fprintln(&messageBuilder, t) 644 | } else { 645 | http.Error(w, logPrintf("Bad Request: Unsupported message type"), http.StatusBadRequest) 646 | return 647 | } 648 | } else { 649 | http.Error(w, logPrintf("Bad Request: Unsupported message type"), http.StatusBadRequest) 650 | return 651 | } 652 | } else { 653 | http.Error(w, logPrintf("Bad Request: Unsupported message type"), http.StatusBadRequest) 654 | return 655 | } 656 | } 657 | } else { 658 | http.Error(w, logPrintf("Bad Request: Unsupported message type"), http.StatusBadRequest) 659 | return 660 | } 661 | } 662 | fmt.Fprintf(&messageBuilder, "\n%s", afterPromptText) 663 | 664 | // Determine configuration flags 665 | isReasoning := false 666 | if strings.TrimSpace(body.Model) == grok3ReasoningModelName { 667 | isReasoning = true 668 | } 669 | 670 | enableSearch := false 671 | if body.EnableSearch > 0 { 672 | enableSearch = true 673 | } 674 | 675 | uploadMessage := false 676 | if body.UploadMessage > 0 { 677 | uploadMessage = true 678 | } 679 | 680 | keepConversation := false 681 | if body.KeepChat > 0 { 682 | keepConversation = true 683 | } else if body.KeepChat < 0 { 684 | keepConversation = *keepChat 685 | } 686 | 687 | ignoreThink := false 688 | if body.IgnoreThinking > 0 { 689 | ignoreThink = true 690 | } else if body.IgnoreThinking < 0 { 691 | ignoreThink = *ignoreThinking 692 | } 693 | 694 | // Initialize GrokClient with selected options 695 | grokClient := NewGrokClient(cookie, isReasoning, enableSearch, uploadMessage, keepConversation, ignoreThink) 696 | log.Printf("Use the cookie with index %d to request Grok 3 Web API", cookieIndex+1) 697 | // Send the message to Grok 3 Web API 698 | resp, err := grokClient.sendMessage(messageBuilder.String()) 699 | if err != nil { 700 | http.Error(w, logPrintf("Error: %v", err), http.StatusInternalServerError) 701 | return 702 | } 703 | defer resp.Body.Close() 704 | respBody, err := decompressBody(resp) 705 | if err != nil { 706 | http.Error(w, logPrintf("Error: %v", err), http.StatusInternalServerError) 707 | return 708 | } 709 | defer respBody.Close() 710 | 711 | // Handle the response based on streaming option 712 | if body.Stream { 713 | grokClient.createOpenAIStreamingResponse(respBody)(w, r) 714 | } else { 715 | grokClient.createOpenAIFullResponse(respBody)(w, r) 716 | } 717 | _, _ = io.ReadAll(respBody) 718 | } 719 | 720 | // listModels handles GET requests to /v1/models, returning a list of available models in OpenAI's format. 721 | func listModels(w http.ResponseWriter, r *http.Request) { 722 | // Log the request details 723 | log.Printf("Request from %s for %s", r.RemoteAddr, listModelsPath) 724 | 725 | if r.URL.Path != listModelsPath { 726 | http.Error(w, logPrintf("Requested Path %s Not Found", r.URL.Path), http.StatusNotFound) 727 | return 728 | } 729 | 730 | if r.Method != http.MethodGet { 731 | http.Error(w, logPrintf("Method %s Not Allowed", r.Method), http.StatusMethodNotAllowed) 732 | return 733 | } 734 | 735 | list := ModelList{ 736 | Object: "list", 737 | Data: []ModelData{ 738 | { 739 | Id: grok3ModelName, 740 | Object: "model", 741 | Owned_by: "xAI", 742 | }, 743 | { 744 | Id: grok3ReasoningModelName, 745 | Object: "model", 746 | Owned_by: "xAI", 747 | }, 748 | }, 749 | } 750 | 751 | w.Header().Set("Content-Type", "application/json") 752 | if err := json.NewEncoder(w).Encode(list); err != nil { 753 | http.Error(w, logPrintf("Encoding response error: %v", err), http.StatusInternalServerError) 754 | return 755 | } 756 | } 757 | 758 | // main parses command-line flags, sets up the HTTP server, and starts listening for requests. 759 | func main() { 760 | // Define command-line flags 761 | apiToken = flag.String("token", "", "Authentication token (GROK3_AUTH_TOKEN)") 762 | cookie := flag.String("cookie", "", "Grok cookie(s) (GROK3_COOKIE)") 763 | cookieFile := flag.String("cookieFile", "", "A text file which contains Grok cookies line by line") 764 | textBeforePrompt = flag.String("textBeforePrompt", defaultBeforePromptText, "Text before the prompt") 765 | textAfterPrompt = flag.String("textAfterPrompt", "", "Text after the prompt") 766 | keepChat = flag.Bool("keepChat", false, "Retain the chat conversation") 767 | ignoreThinking = flag.Bool("ignoreThinking", false, "Ignore the thinking content while using the reasoning model") 768 | charsLimit = flag.Uint("charsLimit", messageCharsLimit, "Upload the message as a file if the count of its characters is greater than this limit") 769 | httpProxy = flag.String("httpProxy", "", "HTTP/SOCKS5 proxy") 770 | port := flag.Uint("port", 8180, "Server port") 771 | flag.Parse() 772 | 773 | // Validate port number 774 | if *port > 65535 { 775 | log.Fatalf("Server port %d is greater than 65535", *port) 776 | } 777 | 778 | // Set authentication token from flag or environment variable 779 | *apiToken = strings.TrimSpace(*apiToken) 780 | if *apiToken == "" { 781 | *apiToken = strings.TrimSpace(os.Getenv("GROK3_AUTH_TOKEN")) 782 | if *apiToken == "" { 783 | log.Fatal("Authentication token (GROK3_AUTH_TOKEN) is unset") 784 | } 785 | } 786 | 787 | // Set cookies from flag or environment variable 788 | *cookie = strings.TrimSpace(*cookie) 789 | if *cookie == "" { 790 | *cookie = strings.TrimSpace(os.Getenv("GROK3_COOKIE")) 791 | } 792 | if *cookie != "" { 793 | err := json.Unmarshal([]byte(*cookie), &grokCookies) 794 | if err != nil { 795 | grokCookies = []string{*cookie} 796 | } 797 | } 798 | // Get cookies from `cookieFile` 799 | if *cookieFile != "" { 800 | file, err := os.Open(*cookieFile) 801 | if err != nil { 802 | log.Fatalf("Open file %s error: %v", *cookieFile, err) 803 | } 804 | defer file.Close() 805 | 806 | scanner := bufio.NewScanner(file) 807 | for scanner.Scan() { 808 | c := strings.TrimSpace(scanner.Text()) 809 | if c != "" { 810 | grokCookies = append(grokCookies, c) 811 | } 812 | } 813 | if err = scanner.Err(); err != nil { 814 | log.Fatalf("Reading file %s error: %v", *cookieFile, err) 815 | } 816 | } 817 | 818 | // Configure HTTP client with proxy if provided 819 | *httpProxy = strings.TrimSpace(*httpProxy) 820 | if *httpProxy != "" { 821 | proxyURL, err := url.Parse(*httpProxy) 822 | if err == nil { 823 | httpClient.Transport = &http.Transport{ 824 | Proxy: http.ProxyURL(proxyURL), 825 | DialContext: (&net.Dialer{ 826 | Timeout: 30 * time.Second, 827 | KeepAlive: 30 * time.Second, 828 | }).DialContext, 829 | ForceAttemptHTTP2: true, 830 | MaxIdleConns: 10, 831 | IdleConnTimeout: 600 * time.Second, 832 | TLSHandshakeTimeout: 20 * time.Second, 833 | } 834 | } else { 835 | log.Fatalf("Parsing HTTP/SOCKS5 proxy error：%v", err) 836 | } 837 | } 838 | 839 | // Register HTTP handlers 840 | http.HandleFunc(completionsPath, handleChatCompletion) 841 | http.HandleFunc(listModelsPath, listModels) 842 | log.Printf("Server starting on :%d", *port) 843 | 844 | // Start the HTTP server 845 | log.Fatal(http.ListenAndServe(fmt.Sprintf(":%d", *port), nil)) 846 | } 847 | --------------------------------------------------------------------------------